Skip to content

feat: adds reference to claims #622

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

Merged
merged 1 commit into from
May 29, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# CHANGELOG

## v7.1.0 (2025-05-29)

- Adds `Reference` to Claims
- Adds `ReplacementOrder` and `StoreCredit` to Claim `PaymentMethod` list

## v7.0.1 (2025-05-27)

- Corrects the endpoint used for creating/updating UPS accounts
2 changes: 1 addition & 1 deletion EasyPost.nuspec
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
<metadata>
<id>EasyPost-Official</id>
<title>EasyPost (Official)</title>
<version>7.0.1</version>
<version>7.1.0</version>
<authors>EasyPost</authors>
<owners>EasyPost</owners>
<projectUrl>https://www.easypost.com</projectUrl>
6 changes: 6 additions & 0 deletions EasyPost/Models/API/Claim.cs
Original file line number Diff line number Diff line change
@@ -83,6 +83,12 @@ public class Claim : EasyPostObject, Parameters.IClaimParameter
[JsonProperty("recipient_name")]
public string? RecipientName { get; set; }

/// <summary>
/// An optional value that may be used in place of ID when doing Retrieve calls for this claim.
/// </summary>
[JsonProperty("reference")]
public string? Reference { get; set; }

/// <summary>
/// The amount that has been requested for reimbursement.
/// </summary>
12 changes: 12 additions & 0 deletions EasyPost/Models/API/ClaimPaymentMethod.cs
Original file line number Diff line number Diff line change
@@ -23,6 +23,18 @@ public class ClaimPaymentMethod : ValueEnum
// ReSharper disable once InconsistentNaming
public static readonly ClaimPaymentMethod ACH = new(3, "ach");

/// <summary>
/// An enum representing paying a claim reimbursement via a replacement order.
/// </summary>
// ReSharper disable once InconsistentNaming
public static readonly ClaimPaymentMethod ReplacementOrder = new(4, "replacement_order");

/// <summary>
/// An enum representing paying a claim reimbursement via store credit.
/// </summary>
// ReSharper disable once InconsistentNaming
public static readonly ClaimPaymentMethod StoreCredit = new(5, "store_credit");

/// <summary>
/// Initializes a new instance of the <see cref="ClaimPaymentMethod"/> class.
/// </summary>
6 changes: 6 additions & 0 deletions EasyPost/Parameters/Claim/Create.cs
Original file line number Diff line number Diff line change
@@ -64,6 +64,12 @@ public class Create : BaseParameters<Models.API.Claim>, IClaimParameter
[TopLevelRequestParameter(Necessity.Optional, "recipient_name")]
public string? RecipientName { get; set; }

/// <summary>
/// An optional value that may be used in place of ID when doing Retrieve calls for this claim.
/// </summary>
[TopLevelRequestParameter(Necessity.Optional, "reference")]
public string? Reference { get; set; }

/// <summary>
/// The email address of the contact for the claim.
/// </summary>
6 changes: 3 additions & 3 deletions EasyPost/Properties/VersionInfo.cs
Original file line number Diff line number Diff line change
@@ -2,6 +2,6 @@

// Version information for an assembly must follow semantic versioning
// When releasing a release candidate, append a 4th digit being the number of the release candidate
[assembly: AssemblyVersion("7.0.1")]
[assembly: AssemblyFileVersion("7.0.1")]
[assembly: AssemblyInformationalVersion("7.0.1")]
[assembly: AssemblyVersion("7.1.0")]
[assembly: AssemblyFileVersion("7.1.0")]
[assembly: AssemblyInformationalVersion("7.1.0")]

Unchanged files with check annotations Beta

public bool? ByDrone { get; set; }
[JsonProperty("carrier_insurance_amount")]
public string? CarrierInsuranceAmount { get; set; }

Check warning on line 83 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 83 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

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

Check warning on line 83 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 83 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

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

Check warning on line 83 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 83 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net90)

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

Check warning on line 83 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 83 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

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 135 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 135 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

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

Check warning on line 135 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 135 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

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

Check warning on line 135 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 135 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net90)

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

Check warning on line 135 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 135 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

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

Check warning on line 138 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 138 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

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

Check warning on line 138 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 138 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

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

Check warning on line 138 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 138 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net90)

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

Check warning on line 138 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 138 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

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

Check warning on line 141 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 141 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

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

Check warning on line 141 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 141 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

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

Check warning on line 141 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 141 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net90)

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

Check warning on line 141 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 141 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

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

Check warning on line 144 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 144 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

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

Check warning on line 144 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 144 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

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

Check warning on line 144 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 144 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net90)

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

Check warning on line 144 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 144 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

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 153 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 153 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

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

Check warning on line 153 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 153 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

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

Check warning on line 153 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 153 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net90)

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

Check warning on line 153 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 153 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

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 162 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 162 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

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

Check warning on line 162 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 162 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

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

Check warning on line 162 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 162 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net90)

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

Check warning on line 162 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 162 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

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

Check warning on line 165 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 165 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

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

Check warning on line 165 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 165 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

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

Check warning on line 165 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 165 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net90)

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

Check warning on line 165 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 165 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

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

Check warning on line 168 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 168 in EasyPost/Models/API/Options.cs

GitHub Actions / lint

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

Check warning on line 168 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 168 in EasyPost/Models/API/Options.cs

GitHub Actions / FSharp_Compatibility_Tests

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

Check warning on line 168 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 168 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net90)

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

Check warning on line 168 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 168 in EasyPost/Models/API/Options.cs

GitHub Actions / NET_Tests (Net80)

Missing XML comment for publicly visible type or member 'Options.DeclaredValue'
[JsonProperty("delivered_duty_paid")]
public bool? DeliveredDutyPaid { get; set; }
/// <summary>
/// <a href="https://docs.easypost.com/docs/carrier-accounts#create-a-carrieraccount">Parameters</a> for <see cref="EasyPost.Services.CarrierAccountService.Create(ACreate, System.Threading.CancellationToken)"/> API calls.
/// </summary>
[ExcludeFromCodeCoverage]

Check warning on line 11 in EasyPost/Parameters/CarrierAccount/CreateOauth.cs

GitHub Actions / Coverage_Requirements

'ACreate.ACreate()' is obsolete: 'Use ACreate(CarrierAccountType type) or ACreate(string type) instead.'

Check warning on line 11 in EasyPost/Parameters/CarrierAccount/CreateOauth.cs

GitHub Actions / lint

'ACreate.ACreate()' is obsolete: 'Use ACreate(CarrierAccountType type) or ACreate(string type) instead.'

Check warning on line 11 in EasyPost/Parameters/CarrierAccount/CreateOauth.cs

GitHub Actions / Visual_Basic_Compatibility_Test

'ACreate.ACreate()' is obsolete: 'Use ACreate(CarrierAccountType type) or ACreate(string type) instead.'

Check warning on line 11 in EasyPost/Parameters/CarrierAccount/CreateOauth.cs

GitHub Actions / FSharp_Compatibility_Tests

'ACreate.ACreate()' is obsolete: 'Use ACreate(CarrierAccountType type) or ACreate(string type) instead.'

Check warning on line 11 in EasyPost/Parameters/CarrierAccount/CreateOauth.cs

GitHub Actions / NET_Tests (Net70)

'ACreate.ACreate()' is obsolete: 'Use ACreate(CarrierAccountType type) or ACreate(string type) instead.'

Check warning on line 11 in EasyPost/Parameters/CarrierAccount/CreateOauth.cs

GitHub Actions / NET_Tests (Net90)

'ACreate.ACreate()' is obsolete: 'Use ACreate(CarrierAccountType type) or ACreate(string type) instead.'

Check warning on line 11 in EasyPost/Parameters/CarrierAccount/CreateOauth.cs

GitHub Actions / NET_Tests (Net60)

'ACreate.ACreate()' is obsolete: 'Use ACreate(CarrierAccountType type) or ACreate(string type) instead.'

Check warning on line 11 in EasyPost/Parameters/CarrierAccount/CreateOauth.cs

GitHub Actions / NET_Tests (Net80)

'ACreate.ACreate()' is obsolete: 'Use ACreate(CarrierAccountType type) or ACreate(string type) instead.'
public class CreateOauth : ACreate
{
#region Request Parameters
#region Request Parameters
/// <summary>
/// Only records created after the given ID will be included. May not be used with <see cref="BeforeId"/>.

Check warning on line 17 in EasyPost/Parameters/User/AllChildren.cs

GitHub Actions / Roslyn_Static_Analysis

XML comment has cref attribute 'BeforeId' that could not be resolved

Check warning on line 17 in EasyPost/Parameters/User/AllChildren.cs

GitHub Actions / Roslyn_Static_Analysis

XML comment has cref attribute 'BeforeId' that could not be resolved

Check warning on line 17 in EasyPost/Parameters/User/AllChildren.cs

GitHub Actions / Roslyn_Static_Analysis

XML comment has cref attribute 'BeforeId' that could not be resolved

Check warning on line 17 in EasyPost/Parameters/User/AllChildren.cs

GitHub Actions / Roslyn_Static_Analysis

XML comment has cref attribute 'BeforeId' that could not be resolved

Check warning on line 17 in EasyPost/Parameters/User/AllChildren.cs

GitHub Actions / Roslyn_Static_Analysis

XML comment has cref attribute 'BeforeId' that could not be resolved

Check warning on line 17 in EasyPost/Parameters/User/AllChildren.cs

GitHub Actions / Roslyn_Static_Analysis

XML comment has cref attribute 'BeforeId' that could not be resolved

Check warning on line 17 in EasyPost/Parameters/User/AllChildren.cs

GitHub Actions / Roslyn_Static_Analysis

XML comment has cref attribute 'BeforeId' that could not be resolved

Check warning on line 17 in EasyPost/Parameters/User/AllChildren.cs

GitHub Actions / Roslyn_Static_Analysis

XML comment has cref attribute 'BeforeId' that could not be resolved

Check warning on line 17 in EasyPost/Parameters/User/AllChildren.cs

GitHub Actions / Integration_Tests

XML comment has cref attribute 'BeforeId' that could not be resolved
/// </summary>
[TopLevelRequestParameter(Necessity.Optional, "after_id")]
public string? AfterId { get; set; }
{
parameters = new Dictionary<string, object>
{
{ "return_url", returnUrl },

Check warning on line 187 in EasyPost/Services/Beta/ReferralCustomerService.cs

GitHub Actions / Roslyn_Static_Analysis

Possible null reference argument for parameter 'value' in 'void Dictionary<string, object>.Add(string key, object value)'.

Check warning on line 187 in EasyPost/Services/Beta/ReferralCustomerService.cs

GitHub Actions / Roslyn_Static_Analysis

Possible null reference argument for parameter 'value' in 'void Dictionary<string, object>.Add(string key, object value)'.
};
}