Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[POC] Denote the interdependency between parameters in a parameter set #571

Merged
merged 11 commits into from
Jun 12, 2024
Prev Previous commit
- Update CHANGELOG
nwithan8 committed Jun 12, 2024
commit 5013627e018f463d01578775811a6cde99d94211
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# CHANGELOG

## Next Release

- Enforce one-or-other for `Shipment` and `Batch` parameters in `Pickup.Create` parameter set
- Add internal parameter dependency utility

## v6.5.2 (2024-06-12)

- Fix `Shipment` parameter requirement for `Pickup.Create` parameter set

Unchanged files with check annotations Beta

{
AllChildren parameters = Filters != null ? (AllChildren)Filters : new AllChildren();
parameters.BeforeId = entries.Last().Id;

Check warning on line 35 in EasyPost/Models/API/ChildUserCollection.cs

GitHub Actions / Coverage_Requirements

'AllChildren.BeforeId' is obsolete: 'This parameter is not supported by the API.'

Check warning on line 35 in EasyPost/Models/API/ChildUserCollection.cs

GitHub Actions / NET_Tests (Net50)

'AllChildren.BeforeId' is obsolete: 'This parameter is not supported by the API.'

Check warning on line 35 in EasyPost/Models/API/ChildUserCollection.cs

GitHub Actions / lint

'AllChildren.BeforeId' is obsolete: 'This parameter is not supported by the API.'

Check warning on line 35 in EasyPost/Models/API/ChildUserCollection.cs

GitHub Actions / lint

'AllChildren.BeforeId' is obsolete: 'This parameter is not supported by the API.'

Check warning on line 35 in EasyPost/Models/API/ChildUserCollection.cs

GitHub Actions / lint

'AllChildren.BeforeId' is obsolete: 'This parameter is not supported by the API.'

Check warning on line 35 in EasyPost/Models/API/ChildUserCollection.cs

GitHub Actions / NET_Tests (Net80)

'AllChildren.BeforeId' is obsolete: 'This parameter is not supported by the API.'

Check warning on line 35 in EasyPost/Models/API/ChildUserCollection.cs

GitHub Actions / NET_Tests (Net60)

'AllChildren.BeforeId' is obsolete: 'This parameter is not supported by the API.'

Check warning on line 35 in EasyPost/Models/API/ChildUserCollection.cs

GitHub Actions / Visual_Basic_Compatibility_Test

'AllChildren.BeforeId' is obsolete: 'This parameter is not supported by the API.'

Check warning on line 35 in EasyPost/Models/API/ChildUserCollection.cs

GitHub Actions / NET_Tests (Net70)

'AllChildren.BeforeId' is obsolete: 'This parameter is not supported by the API.'

Check warning on line 35 in EasyPost/Models/API/ChildUserCollection.cs

GitHub Actions / NET_Tests (NetStandard20)

'AllChildren.BeforeId' is obsolete: 'This parameter is not supported by the API.'

Check warning on line 35 in EasyPost/Models/API/ChildUserCollection.cs

GitHub Actions / FSharp_Compatibility_Tests

'AllChildren.BeforeId' is obsolete: 'This parameter is not supported by the API.'
if (pageSize != null)
{
public bool? ByDrone { get; set; }
[JsonProperty("carrier_insurance_amount")]
public string? CarrierInsuranceAmount { get; set; }

Check warning on line 118 in EasyPost/Models/API/Options.cs

GitHub Actions / Coverage_Requirements

Missing XML comment for publicly visible type or member 'Options.CarrierInsuranceAmount'

Check warning on line 118 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net50)

Missing XML comment for publicly visible type or member 'Options.CarrierInsuranceAmount'

Check warning on line 118 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

Missing XML comment for publicly visible type or member 'Options.CarrierInsuranceAmount'

Check warning on line 118 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

Missing XML comment for publicly visible type or member 'Options.CarrierInsuranceAmount'

Check warning on line 118 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

Missing XML comment for publicly visible type or member 'Options.CarrierInsuranceAmount'

Check warning on line 118 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

Missing XML comment for publicly visible type or member 'Options.CarrierInsuranceAmount'

Check warning on line 118 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net60)

Missing XML comment for publicly visible type or member 'Options.CarrierInsuranceAmount'

Check warning on line 118 in EasyPost/Models/API/Options.cs

GitHub Actions / Visual_Basic_Compatibility_Test

Missing XML comment for publicly visible type or member 'Options.CarrierInsuranceAmount'

Check warning on line 118 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net70)

Missing XML comment for publicly visible type or member 'Options.CarrierInsuranceAmount'

Check warning on line 118 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (NetStandard20)

Missing XML comment for publicly visible type or member 'Options.CarrierInsuranceAmount'

Check warning on line 118 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

Missing XML comment for publicly visible type or member 'Options.CarrierInsuranceAmount'
/// <summary>
/// Assign an email address to receive carrier notifications.
public string? CodMethod { get; set; }
[JsonProperty("commercial_invoice_format")]
public string? CommercialInvoiceFormat { get; set; }

Check warning on line 170 in EasyPost/Models/API/Options.cs

GitHub Actions / Coverage_Requirements

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceFormat'

Check warning on line 170 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net50)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceFormat'

Check warning on line 170 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceFormat'

Check warning on line 170 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceFormat'

Check warning on line 170 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceFormat'

Check warning on line 170 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceFormat'

Check warning on line 170 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net60)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceFormat'

Check warning on line 170 in EasyPost/Models/API/Options.cs

GitHub Actions / Visual_Basic_Compatibility_Test

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceFormat'

Check warning on line 170 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net70)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceFormat'

Check warning on line 170 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (NetStandard20)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceFormat'

Check warning on line 170 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceFormat'
[JsonProperty("commercial_invoice_letterhead")]
public string? CommercialInvoiceLetterhead { get; set; }

Check warning on line 173 in EasyPost/Models/API/Options.cs

GitHub Actions / Coverage_Requirements

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceLetterhead'

Check warning on line 173 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net50)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceLetterhead'

Check warning on line 173 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceLetterhead'

Check warning on line 173 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceLetterhead'

Check warning on line 173 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net60)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceLetterhead'

Check warning on line 173 in EasyPost/Models/API/Options.cs

GitHub Actions / Visual_Basic_Compatibility_Test

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceLetterhead'

Check warning on line 173 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net70)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceLetterhead'

Check warning on line 173 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (NetStandard20)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceLetterhead'

Check warning on line 173 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceLetterhead'
[JsonProperty("commercial_invoice_signature")]
public string? CommercialInvoiceSignature { get; set; }

Check warning on line 176 in EasyPost/Models/API/Options.cs

GitHub Actions / Coverage_Requirements

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSignature'

Check warning on line 176 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net50)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSignature'

Check warning on line 176 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSignature'

Check warning on line 176 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net60)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSignature'

Check warning on line 176 in EasyPost/Models/API/Options.cs

GitHub Actions / Visual_Basic_Compatibility_Test

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSignature'

Check warning on line 176 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net70)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSignature'

Check warning on line 176 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (NetStandard20)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSignature'

Check warning on line 176 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSignature'
[JsonProperty("commercial_invoice_size")]
public string? CommercialInvoiceSize { get; set; }

Check warning on line 179 in EasyPost/Models/API/Options.cs

GitHub Actions / Coverage_Requirements

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSize'

Check warning on line 179 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net50)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSize'

Check warning on line 179 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSize'

Check warning on line 179 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net60)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSize'

Check warning on line 179 in EasyPost/Models/API/Options.cs

GitHub Actions / Visual_Basic_Compatibility_Test

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSize'

Check warning on line 179 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net70)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSize'

Check warning on line 179 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (NetStandard20)

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSize'

Check warning on line 179 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

Missing XML comment for publicly visible type or member 'Options.CommercialInvoiceSize'
/// <summary>
/// A description of the content of the shipment.
public string? ContentDescription { get; set; }
[JsonProperty("cost_center")]
public string? CostCenter { get; set; }

Check warning on line 188 in EasyPost/Models/API/Options.cs

GitHub Actions / Coverage_Requirements

Missing XML comment for publicly visible type or member 'Options.CostCenter'

Check warning on line 188 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net50)

Missing XML comment for publicly visible type or member 'Options.CostCenter'

Check warning on line 188 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

Missing XML comment for publicly visible type or member 'Options.CostCenter'

Check warning on line 188 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net60)

Missing XML comment for publicly visible type or member 'Options.CostCenter'

Check warning on line 188 in EasyPost/Models/API/Options.cs

GitHub Actions / Visual_Basic_Compatibility_Test

Missing XML comment for publicly visible type or member 'Options.CostCenter'

Check warning on line 188 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net70)

Missing XML comment for publicly visible type or member 'Options.CostCenter'

Check warning on line 188 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (NetStandard20)

Missing XML comment for publicly visible type or member 'Options.CostCenter'

Check warning on line 188 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

Missing XML comment for publicly visible type or member 'Options.CostCenter'
/// <summary>
/// Which currency this <see cref="Shipment"/> will show for rates if carrier allows.
public string? Currency { get; set; }
[JsonProperty("customs_broker_address_id")]
public string? CustomsBrokerAddressId { get; set; }

Check warning on line 197 in EasyPost/Models/API/Options.cs

GitHub Actions / Coverage_Requirements

Missing XML comment for publicly visible type or member 'Options.CustomsBrokerAddressId'

Check warning on line 197 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net50)

Missing XML comment for publicly visible type or member 'Options.CustomsBrokerAddressId'

Check warning on line 197 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

Missing XML comment for publicly visible type or member 'Options.CustomsBrokerAddressId'

Check warning on line 197 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net60)

Missing XML comment for publicly visible type or member 'Options.CustomsBrokerAddressId'

Check warning on line 197 in EasyPost/Models/API/Options.cs

GitHub Actions / Visual_Basic_Compatibility_Test

Missing XML comment for publicly visible type or member 'Options.CustomsBrokerAddressId'

Check warning on line 197 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net70)

Missing XML comment for publicly visible type or member 'Options.CustomsBrokerAddressId'

Check warning on line 197 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (NetStandard20)

Missing XML comment for publicly visible type or member 'Options.CustomsBrokerAddressId'

Check warning on line 197 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

Missing XML comment for publicly visible type or member 'Options.CustomsBrokerAddressId'
[JsonProperty("customs_include_shipping")]
public string? CustomsIncludeShipping { get; set; }

Check warning on line 200 in EasyPost/Models/API/Options.cs

GitHub Actions / Coverage_Requirements

Missing XML comment for publicly visible type or member 'Options.CustomsIncludeShipping'

Check warning on line 200 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net50)

Missing XML comment for publicly visible type or member 'Options.CustomsIncludeShipping'

Check warning on line 200 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

Missing XML comment for publicly visible type or member 'Options.CustomsIncludeShipping'

Check warning on line 200 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net60)

Missing XML comment for publicly visible type or member 'Options.CustomsIncludeShipping'

Check warning on line 200 in EasyPost/Models/API/Options.cs

GitHub Actions / Visual_Basic_Compatibility_Test

Missing XML comment for publicly visible type or member 'Options.CustomsIncludeShipping'

Check warning on line 200 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net70)

Missing XML comment for publicly visible type or member 'Options.CustomsIncludeShipping'

Check warning on line 200 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (NetStandard20)

Missing XML comment for publicly visible type or member 'Options.CustomsIncludeShipping'

Check warning on line 200 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

Missing XML comment for publicly visible type or member 'Options.CustomsIncludeShipping'
[JsonProperty("declared_value")]
public double? DeclaredValue { get; set; }

Check warning on line 203 in EasyPost/Models/API/Options.cs

GitHub Actions / Coverage_Requirements

Missing XML comment for publicly visible type or member 'Options.DeclaredValue'

Check warning on line 203 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net50)

Missing XML comment for publicly visible type or member 'Options.DeclaredValue'

Check warning on line 203 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

Missing XML comment for publicly visible type or member 'Options.DeclaredValue'

Check warning on line 203 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net60)

Missing XML comment for publicly visible type or member 'Options.DeclaredValue'

Check warning on line 203 in EasyPost/Models/API/Options.cs

GitHub Actions / Visual_Basic_Compatibility_Test

Missing XML comment for publicly visible type or member 'Options.DeclaredValue'

Check warning on line 203 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net70)

Missing XML comment for publicly visible type or member 'Options.DeclaredValue'

Check warning on line 203 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (NetStandard20)

Missing XML comment for publicly visible type or member 'Options.DeclaredValue'

Check warning on line 203 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

Missing XML comment for publicly visible type or member 'Options.DeclaredValue'
[JsonProperty("delivered_duty_paid")]
public bool? DeliveredDutyPaid { get; set; }