Skip to content

Commit 02e3685

Browse files
committed
Rename some properties for consistency
1 parent 2995634 commit 02e3685

File tree

3 files changed

+157
-34
lines changed

3 files changed

+157
-34
lines changed

src/Stripe.net/Entities/Accounts/Account.cs

+10-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,16 @@ public class Account : StripeEntity, IHasId, IHasMetadata, IHasObject, IPaymentS
1414
public string Object { get; set; }
1515

1616
#region Expandable BusinessLogo
17-
public string BusinessLogoFileId { get; set; }
1817

18+
/// <summary>
19+
/// (ID of a <see cref="File"/>) A logo for this account (at least 128px x 128px).
20+
/// <para>Expandable.</para>
21+
/// </summary>
22+
public string BusinessLogoId { get; set; }
23+
24+
/// <summary>
25+
/// (Expanded) A logo for this account (at least 128px x 128px).
26+
/// </summary>
1927
[JsonIgnore]
2028
public File BusinessLogo { get; set; }
2129

@@ -24,7 +32,7 @@ internal object InternalBusinessLogo
2432
{
2533
set
2634
{
27-
StringOrObject<File>.Map(value, s => this.BusinessLogoFileId = s, o => this.BusinessLogo = o);
35+
StringOrObject<File>.Map(value, s => this.BusinessLogoId = s, o => this.BusinessLogo = o);
2836
}
2937
}
3038
#endregion

src/Stripe.net/Entities/Accounts/LegalEntityVerification.cs

+22-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,18 @@ public class LegalEntityVerification : StripeEntity
1212
public string DetailsCode { get; set; }
1313

1414
#region Expandable Document
15+
16+
/// <summary>
17+
/// (ID of a <see cref="File"/>) A photo (jpg or png) of the front of an identifying
18+
/// document, either a passport or local ID card.
19+
/// <para>Expandable.</para>
20+
/// </summary>
1521
public string DocumentId { get; set; }
1622

23+
/// <summary>
24+
/// (Expanded) A photo (jpg or png) of the front of an identifying document, either a
25+
/// passport or local ID card.
26+
/// </summary>
1727
[JsonIgnore]
1828
public File Document { get; set; }
1929

@@ -28,8 +38,18 @@ internal object InternalDocument
2838
#endregion
2939

3040
#region Expandable Document Back
31-
public string DocumentIdBack { get; set; }
3241

42+
/// <summary>
43+
/// (ID of a <see cref="File"/>) A photo (jpg or png) of the back of an identifying
44+
/// document, either a passport or local ID card.
45+
/// <para>Expandable.</para>
46+
/// </summary>
47+
public string DocumentBackId { get; set; }
48+
49+
/// <summary>
50+
/// (Expanded) A photo (jpg or png) of the back of an identifying document, either a
51+
/// passport or local ID card.
52+
/// </summary>
3353
[JsonIgnore]
3454
public File DocumentBack { get; set; }
3555

@@ -38,7 +58,7 @@ internal object InternalDocumentBack
3858
{
3959
set
4060
{
41-
StringOrObject<File>.Map(value, s => this.DocumentIdBack = s, o => this.DocumentBack = o);
61+
StringOrObject<File>.Map(value, s => this.DocumentBackId = s, o => this.DocumentBack = o);
4262
}
4363
}
4464
#endregion

src/Stripe.net/Entities/Disputes/Evidence.cs

+125-30
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,26 @@ public class Evidence : StripeEntity
1212
public string BillingAddress { get; set; }
1313

1414
#region Expandable Cancellation Policy
15-
public string CancellationPolicyFileId { get; set; }
1615

16+
/// <summary>
17+
/// (ID of a <see cref="File"/>) Your subscription cancellation policy, as shown to the
18+
/// customer.
19+
/// <para>Expandable.</para>
20+
/// </summary>
21+
public string CancellationPolicyId { get; set; }
22+
23+
/// <summary>
24+
/// (Expanded) Your subscription cancellation policy, as shown to the customer.
25+
/// </summary>
1726
[JsonIgnore]
18-
public File CancellationPolicyFile { get; set; }
27+
public File CancellationPolicy { get; set; }
1928

2029
[JsonProperty("cancellation_policy")]
2130
internal object InternalCancellationPolicy
2231
{
2332
set
2433
{
25-
StringOrObject<File>.Map(value, s => this.CancellationPolicyFileId = s, o => this.CancellationPolicyFile = o);
34+
StringOrObject<File>.Map(value, s => this.CancellationPolicyId = s, o => this.CancellationPolicy = o);
2635
}
2736
}
2837
#endregion
@@ -34,17 +43,30 @@ internal object InternalCancellationPolicy
3443
public string CancellationRebuttal { get; set; }
3544

3645
#region Expandable Customer Communication
37-
public string CustomerCommunicationFileId { get; set; }
3846

47+
/// <summary>
48+
/// (ID of a <see cref="File"/>) Any communication with the customer that you feel is
49+
/// relevant to your case. Examples include emails proving that the customer received the
50+
/// product or service, or demonstrating their use of or satisfaction with the product or
51+
/// service.
52+
/// <para>Expandable.</para>
53+
/// </summary>
54+
public string CustomerCommunicationId { get; set; }
55+
56+
/// <summary>
57+
/// (Expanded) Any communication with the customer that you feel is relevant to your case.
58+
/// Examples include emails proving that the customer received the product or service, or
59+
/// demonstrating their use of or satisfaction with the product or service.
60+
/// </summary>
3961
[JsonIgnore]
40-
public File CustomerCommunicationFile { get; set; }
62+
public File CustomerCommunication { get; set; }
4163

4264
[JsonProperty("customer_communication")]
4365
internal object InternalCustomerCommunication
4466
{
4567
set
4668
{
47-
StringOrObject<File>.Map(value, s => this.CustomerCommunicationFileId = s, o => this.CustomerCommunicationFile = o);
69+
StringOrObject<File>.Map(value, s => this.CustomerCommunicationId = s, o => this.CustomerCommunication = o);
4870
}
4971
}
5072
#endregion
@@ -59,33 +81,55 @@ internal object InternalCustomerCommunication
5981
public string CustomerPurchaseIPAddress { get; set; }
6082

6183
#region Expandable Customer Signature
62-
public string CustomerSignatureFileId { get; set; }
6384

85+
/// <summary>
86+
/// (ID of a <see cref="File"/>) A relevant document or contract showing the customer’s
87+
/// signature.
88+
/// <para>Expandable.</para>
89+
/// </summary>
90+
public string CustomerSignatureId { get; set; }
91+
92+
/// <summary>
93+
/// (Expanded) A relevant document or contract showing the customer’s signature.
94+
/// </summary>
6495
[JsonIgnore]
65-
public File CustomerSignatureFile { get; set; }
96+
public File CustomerSignature { get; set; }
6697

6798
[JsonProperty("customer_signature")]
68-
internal object InternalCustomerSignatureFile
99+
internal object InternalCustomerSignature
69100
{
70101
set
71102
{
72-
StringOrObject<File>.Map(value, s => this.CustomerSignatureFileId = s, o => this.CustomerSignatureFile = o);
103+
StringOrObject<File>.Map(value, s => this.CustomerSignatureId = s, o => this.CustomerSignature = o);
73104
}
74105
}
75106
#endregion
76107

77108
#region Expandable Duplicate Charge Documentation
78-
public string DuplicateChargeDocumentationFileId { get; set; }
79109

110+
/// <summary>
111+
/// (ID of a <see cref="File"/>) Documentation for the prior charge that can uniquely
112+
/// identify the charge, such as a receipt, shipping label, work order, etc. This document
113+
/// should be paired with a similar document from the disputed payment that proves the two
114+
/// payments are separate.
115+
/// <para>Expandable.</para>
116+
/// </summary>
117+
public string DuplicateChargeDocumentationId { get; set; }
118+
119+
/// <summary>
120+
/// (Expanded) Documentation for the prior charge that can uniquely identify the charge,
121+
/// such as a receipt, shipping label, work order, etc. This document should be paired with
122+
/// a similar document from the disputed payment that proves the two payments are separate.
123+
/// </summary>
80124
[JsonIgnore]
81-
public File DuplicateChargeDocumentationFile { get; set; }
125+
public File DuplicateChargeDocumentation { get; set; }
82126

83127
[JsonProperty("duplicate_charge_documentation")]
84-
internal object InternalDuplicateChargeDocumentationFile
128+
internal object InternalDuplicateChargeDocumentation
85129
{
86130
set
87131
{
88-
StringOrObject<File>.Map(value, s => this.DuplicateChargeDocumentationFileId = s, o => this.DuplicateChargeDocumentationFile = o);
132+
StringOrObject<File>.Map(value, s => this.DuplicateChargeDocumentationId = s, o => this.DuplicateChargeDocumentation = o);
89133
}
90134
}
91135
#endregion
@@ -100,33 +144,50 @@ internal object InternalDuplicateChargeDocumentationFile
100144
public string ProductDescription { get; set; }
101145

102146
#region Expandable Receipt
103-
public string ReceiptFileId { get; set; }
104147

148+
/// <summary>
149+
/// (ID of a <see cref="File"/>) Any receipt or message sent to the customer notifying them
150+
/// of the charge.
151+
/// <para>Expandable.</para>
152+
/// </summary>
153+
public string ReceiptId { get; set; }
154+
155+
/// <summary>
156+
/// (Expanded) Any receipt or message sent to the customer notifying them of the charge.
157+
/// </summary>
105158
[JsonIgnore]
106-
public File ReceiptFile { get; set; }
159+
public File Receipt { get; set; }
107160

108161
[JsonProperty("receipt")]
109-
internal object InternalReceiptFile
162+
internal object InternalReceipt
110163
{
111164
set
112165
{
113-
StringOrObject<File>.Map(value, s => this.ReceiptFileId = s, o => this.ReceiptFile = o);
166+
StringOrObject<File>.Map(value, s => this.ReceiptId = s, o => this.Receipt = o);
114167
}
115168
}
116169
#endregion
117170

118171
#region Expandable Refund Policy
119-
public string RefundPolicyFileId { get; set; }
120172

173+
/// <summary>
174+
/// (ID of a <see cref="File"/>) Your refund policy, as shown to the customer.
175+
/// <para>Expandable.</para>
176+
/// </summary>
177+
public string RefundPolicyId { get; set; }
178+
179+
/// <summary>
180+
/// (Expanded) Your refund policy, as shown to the customer.
181+
/// </summary>
121182
[JsonIgnore]
122-
public File RefundPolicyFile { get; set; }
183+
public File RefundPolicy { get; set; }
123184

124185
[JsonProperty("refund_policy")]
125-
internal object InternalRefundPolicyFile
186+
internal object InternalRefundPolicy
126187
{
127188
set
128189
{
129-
StringOrObject<File>.Map(value, s => this.RefundPolicyFileId = s, o => this.RefundPolicyFile = o);
190+
StringOrObject<File>.Map(value, s => this.RefundPolicyId = s, o => this.RefundPolicy = o);
130191
}
131192
}
132193
#endregion
@@ -141,17 +202,29 @@ internal object InternalRefundPolicyFile
141202
public string ServiceDate { get; set; }
142203

143204
#region Expandable Service Documentation
144-
public string ServiceDocumentationFileId { get; set; }
145205

206+
/// <summary>
207+
/// (ID of a <see cref="File"/>) Documentation showing proof that a service was provided to
208+
/// the customer. This could include a copy of a signed contract, work order, or other form
209+
/// of written agreement.
210+
/// <para>Expandable.</para>
211+
/// </summary>
212+
public string ServiceDocumentationId { get; set; }
213+
214+
/// <summary>
215+
/// (Expanded) Documentation showing proof that a service was provided to the customer.
216+
/// This could include a copy of a signed contract, work order, or other form of written
217+
/// agreement.
218+
/// </summary>
146219
[JsonIgnore]
147-
public File ServiceDocumentationFile { get; set; }
220+
public File ServiceDocumentation { get; set; }
148221

149222
[JsonProperty("service_documentation")]
150-
internal object InternalServiceDocumentationFile
223+
internal object InternalServiceDocumentation
151224
{
152225
set
153226
{
154-
StringOrObject<File>.Map(value, s => this.ServiceDocumentationFileId = s, o => this.ServiceDocumentationFile = o);
227+
StringOrObject<File>.Map(value, s => this.ServiceDocumentationId = s, o => this.ServiceDocumentation = o);
155228
}
156229
}
157230
#endregion
@@ -166,17 +239,31 @@ internal object InternalServiceDocumentationFile
166239
public string ShippingDate { get; set; }
167240

168241
#region Expandable Shipping Documentation
169-
public string ShippingDocumentationFileId { get; set; }
170242

243+
/// <summary>
244+
/// (ID of a <see cref="File"/>) Documentation showing proof that a product was shipped to
245+
/// the customer at the same address the customer provided to you. This could include a copy
246+
/// of the shipment receipt, shipping label, etc. It should show the customer’s full
247+
/// shipping address, if possible.
248+
/// <para>Expandable.</para>
249+
/// </summary>
250+
public string ShippingDocumentationId { get; set; }
251+
252+
/// <summary>
253+
/// (Expanded) Documentation showing proof that a product was shipped to the customer at
254+
/// the same address the customer provided to you. This could include a copy of the shipment
255+
/// receipt, shipping label, etc. It should show the customer’s full shipping address, if
256+
/// possible.
257+
/// </summary>
171258
[JsonIgnore]
172-
public File ShippingDocumentationFile { get; set; }
259+
public File ShippingDocumentation { get; set; }
173260

174261
[JsonProperty("shipping_documentation")]
175-
internal object InternalShippingDocumentationFile
262+
internal object InternalShippingDocumentation
176263
{
177264
set
178265
{
179-
StringOrObject<File>.Map(value, s => this.ShippingDocumentationFileId = s, o => this.ShippingDocumentationFile = o);
266+
StringOrObject<File>.Map(value, s => this.ShippingDocumentationId = s, o => this.ShippingDocumentation = o);
180267
}
181268
}
182269
#endregion
@@ -185,8 +272,16 @@ internal object InternalShippingDocumentationFile
185272
public string ShippingTrackingNumber { get; set; }
186273

187274
#region Expandable Uncategorized File
275+
276+
/// <summary>
277+
/// (ID of a <see cref="File"/>) Any additional evidence or statements.
278+
/// <para>Expandable.</para>
279+
/// </summary>
188280
public string UncategorizedFileId { get; set; }
189281

282+
/// <summary>
283+
/// (Expanded) Any additional evidence or statements.
284+
/// </summary>
190285
[JsonIgnore]
191286
public File UncategorizedFile { get; set; }
192287

0 commit comments

Comments
 (0)