diff --git a/README.md b/README.md index b6f593d..af4bf6c 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,13 @@ Install-Package JsonSubTypes ## Installation ``` # Package Manager -Install-Package Wallee -Version 5.1.0 +Install-Package Wallee -Version 5.2.0 # .NET CLI -dotnet add package Wallee --version 5.1.0 +dotnet add package Wallee --version 5.2.0 # Paket CLI -paket add Wallee --version 5.1.0 +paket add Wallee --version 5.2.0 # PackageReference - + ``` Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces: @@ -49,6 +49,19 @@ using Wallee.Model; ## Getting Started +Instantiate a configuration like so: +```csharp +new Configuration(this.applicationUserID, this.authenticationKey) +``` +Or if you want to customize the RestSharp client that's being used underneath (e.g set the proxy), use the overloaded constructor: +```csharp +new Configuration(this.applicationUserID, this.authenticationKey, new RestClientOptions() +{ + Proxy = new WebProxy("http://example.com") +}); +``` + +Timeout is customizable separately via the ```Configuration.TimeOut``` property. ```csharp using System; diff --git a/src/Wallee/Client/ApiClient.cs b/src/Wallee/Client/ApiClient.cs index 340959c..cf834b6 100644 --- a/src/Wallee/Client/ApiClient.cs +++ b/src/Wallee/Client/ApiClient.cs @@ -54,23 +54,12 @@ public ApiClient(Configuration config) { Configuration = config; - RestClient = new RestClient(Configuration.BasePath); - } - - /// - /// Initializes a new instance of the class - /// with default configuration. - /// - /// The base path. - public ApiClient(String basePath = "https://app-wallee.com:443/api") - { - if (String.IsNullOrEmpty(basePath)) + if (String.IsNullOrEmpty(Configuration.BasePath)) throw new ArgumentException("basePath cannot be empty"); - var options = new RestClientOptions(basePath) - { - MaxTimeout = 600000 - }; + var options = Configuration.RestClientOptions; + options.BaseUrl = new Uri(Configuration.BasePath); + options.MaxTimeout = 600000; RestClient = new RestClient(options); } @@ -159,7 +148,7 @@ public Object CallApi( { Dictionary defaultHeaderParams = new Dictionary() { - {"x-meta-sdk-version", "5.1.0"}, + {"x-meta-sdk-version", "5.2.0"}, {"x-meta-sdk-language", "csharp"}, {"x-meta-sdk-provider", "wallee"}, {"x-meta-sdk-language-version", Environment.Version.ToString()} @@ -564,7 +553,7 @@ private String ToQueryString(List> queryParams) /// https://docs.microsoft.com/en-us/dotnet/api/system.net.httpwebrequest.timeout?view=netcore-3.1 /// public void ResetTimeout(){ - RestClient.Options.MaxTimeout = 100 * 1000; + Configuration.Timeout = 25; } } diff --git a/src/Wallee/Client/Configuration.cs b/src/Wallee/Client/Configuration.cs index ef34ccc..9ce1bb1 100644 --- a/src/Wallee/Client/Configuration.cs +++ b/src/Wallee/Client/Configuration.cs @@ -5,6 +5,8 @@ using System.IO; using System.Linq; using System.Text; +using RestSharp; + namespace Wallee.Client { @@ -19,7 +21,7 @@ public class Configuration : IReadableConfiguration /// Version of the package. /// /// Version of the package. - public const string Version = "5.1.0"; + public const string Version = "5.2.0"; /// /// Identifier for ISO 8601 DateTime Format @@ -80,7 +82,8 @@ public class Configuration : IReadableConfiguration /// /// The ID of application user. /// The secret authentication key. - public Configuration(string applicationUserID, string authenticationKey) + /// Rest client options for authentication key. + public Configuration(string applicationUserID, string authenticationKey, RestClientOptions restClientOptions) { if(applicationUserID == null){ throw new ArgumentException("Parameter cannot be null", "applicationUserID"); @@ -90,7 +93,8 @@ public Configuration(string applicationUserID, string authenticationKey) } _authenticationKey = authenticationKey; _applicationUserID = applicationUserID; - UserAgent = "Wallee/5.1.0/csharp"; + _restClientOptions = restClientOptions; + UserAgent = "Wallee/5.2.0/csharp"; BasePath = "https://app-wallee.com:443/api"; DefaultHeader = new ConcurrentDictionary(); ApiKey = new ConcurrentDictionary(); @@ -99,6 +103,16 @@ public Configuration(string applicationUserID, string authenticationKey) Timeout = 25; } + + /// + /// Initializes a new instance of the class + /// + /// The ID of application user. + /// The secret authentication key. + public Configuration(string applicationUserID, string authenticationKey) : this(applicationUserID, authenticationKey, new RestClientOptions()) + { + } + #endregion Constructors @@ -154,6 +168,17 @@ public string AuthenticationKey get { return _authenticationKey; } } + private readonly RestClientOptions _restClientOptions; + + /// + /// Gets the Rest Client Options. + /// + /// The rest client options. + public RestClientOptions RestClientOptions + { + get { return _restClientOptions; } + } + /// /// Gets or sets the default header. /// @@ -321,7 +346,7 @@ public void AddDefaultHeader(string key, string value) /// public ApiClient CreateApiClient() { - return new ApiClient(BasePath) { Configuration = this }; + return new ApiClient(this); } @@ -333,8 +358,8 @@ public static String ToDebugReport() String report = "C# SDK (Wallee) Debug Report:\n"; report += " OS: " + System.Environment.OSVersion + "\n"; report += " .NET Framework Version: " + System.Environment.Version + "\n"; - report += " Version of the API: 5.1.0\n"; - report += " SDK Package Version: 5.1.0\n"; + report += " Version of the API: 5.2.0\n"; + report += " SDK Package Version: 5.2.0\n"; return report; } diff --git a/src/Wallee/Model/AbstractAccountUpdate.cs b/src/Wallee/Model/AbstractAccountUpdate.cs index 382aca0..4dd8858 100644 --- a/src/Wallee/Model/AbstractAccountUpdate.cs +++ b/src/Wallee/Model/AbstractAccountUpdate.cs @@ -28,8 +28,9 @@ public AbstractAccountUpdate() } /// - /// Gets or Sets LastModifiedDate + /// The date and time when the object was last modified. /// + /// The date and time when the object was last modified. [DataMember(Name="lastModifiedDate", EmitDefaultValue=false)] public DateTime? LastModifiedDate { get; set; } diff --git a/src/Wallee/Model/AbstractApplicationUserUpdate.cs b/src/Wallee/Model/AbstractApplicationUserUpdate.cs index f6dcfce..5b81492 100644 --- a/src/Wallee/Model/AbstractApplicationUserUpdate.cs +++ b/src/Wallee/Model/AbstractApplicationUserUpdate.cs @@ -21,8 +21,9 @@ namespace Wallee.Model public partial class AbstractApplicationUserUpdate : IEquatable { /// - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public CreationEntityState? State { get; set; } /// diff --git a/src/Wallee/Model/AbstractCustomerActive.cs b/src/Wallee/Model/AbstractCustomerActive.cs index 8acb1c5..d274f56 100644 --- a/src/Wallee/Model/AbstractCustomerActive.cs +++ b/src/Wallee/Model/AbstractCustomerActive.cs @@ -52,8 +52,9 @@ public AbstractCustomerActive() public string GivenName { get; set; } /// - /// Gets or Sets Language + /// The language that is linked to the object. /// + /// The language that is linked to the object. [DataMember(Name="language", EmitDefaultValue=false)] public string Language { get; set; } diff --git a/src/Wallee/Model/AbstractHumanUserUpdate.cs b/src/Wallee/Model/AbstractHumanUserUpdate.cs index 65ff0bd..477f434 100644 --- a/src/Wallee/Model/AbstractHumanUserUpdate.cs +++ b/src/Wallee/Model/AbstractHumanUserUpdate.cs @@ -21,8 +21,9 @@ namespace Wallee.Model public partial class AbstractHumanUserUpdate : IEquatable { /// - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public CreationEntityState? State { get; set; } /// diff --git a/src/Wallee/Model/AbstractSpaceUpdate.cs b/src/Wallee/Model/AbstractSpaceUpdate.cs index 6373e54..9c2c59e 100644 --- a/src/Wallee/Model/AbstractSpaceUpdate.cs +++ b/src/Wallee/Model/AbstractSpaceUpdate.cs @@ -21,8 +21,9 @@ namespace Wallee.Model public partial class AbstractSpaceUpdate : IEquatable { /// - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public CreationEntityState? State { get; set; } /// @@ -33,8 +34,9 @@ public AbstractSpaceUpdate() } /// - /// Gets or Sets LastModifiedDate + /// The date and time when the object was last modified. /// + /// The date and time when the object was last modified. [DataMember(Name="lastModifiedDate", EmitDefaultValue=false)] public DateTime? LastModifiedDate { get; set; } diff --git a/src/Wallee/Model/AbstractSubscriptionAffiliateUpdate.cs b/src/Wallee/Model/AbstractSubscriptionAffiliateUpdate.cs index 0414c44..611c5a3 100644 --- a/src/Wallee/Model/AbstractSubscriptionAffiliateUpdate.cs +++ b/src/Wallee/Model/AbstractSubscriptionAffiliateUpdate.cs @@ -21,8 +21,9 @@ namespace Wallee.Model public partial class AbstractSubscriptionAffiliateUpdate : IEquatable { /// - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public CreationEntityState? State { get; set; } /// @@ -33,8 +34,9 @@ public AbstractSubscriptionAffiliateUpdate() } /// - /// Gets or Sets Language + /// The language that is linked to the object. /// + /// The language that is linked to the object. [DataMember(Name="language", EmitDefaultValue=false)] public string Language { get; set; } diff --git a/src/Wallee/Model/AbstractSubscriptionProductActive.cs b/src/Wallee/Model/AbstractSubscriptionProductActive.cs index 20542a9..d882654 100644 --- a/src/Wallee/Model/AbstractSubscriptionProductActive.cs +++ b/src/Wallee/Model/AbstractSubscriptionProductActive.cs @@ -21,8 +21,9 @@ namespace Wallee.Model public partial class AbstractSubscriptionProductActive : IEquatable { /// - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public SubscriptionProductState? State { get; set; } /// diff --git a/src/Wallee/Model/AbstractTokenUpdate.cs b/src/Wallee/Model/AbstractTokenUpdate.cs index 6f36ffb..13c412d 100644 --- a/src/Wallee/Model/AbstractTokenUpdate.cs +++ b/src/Wallee/Model/AbstractTokenUpdate.cs @@ -49,8 +49,9 @@ public AbstractTokenUpdate() public bool? EnabledForOneClickPayment { get; set; } /// - /// Gets or Sets Language + /// The language that is linked to the object. /// + /// The language that is linked to the object. [DataMember(Name="language", EmitDefaultValue=false)] public string Language { get; set; } diff --git a/src/Wallee/Model/AbstractTransactionPending.cs b/src/Wallee/Model/AbstractTransactionPending.cs index a039753..bce606e 100644 --- a/src/Wallee/Model/AbstractTransactionPending.cs +++ b/src/Wallee/Model/AbstractTransactionPending.cs @@ -91,8 +91,9 @@ public AbstractTransactionPending() public string InvoiceMerchantReference { get; set; } /// - /// Gets or Sets Language + /// The language that is linked to the object. /// + /// The language that is linked to the object. [DataMember(Name="language", EmitDefaultValue=false)] public string Language { get; set; } diff --git a/src/Wallee/Model/AbstractWebhookListenerUpdate.cs b/src/Wallee/Model/AbstractWebhookListenerUpdate.cs index 28b60a5..160eea8 100644 --- a/src/Wallee/Model/AbstractWebhookListenerUpdate.cs +++ b/src/Wallee/Model/AbstractWebhookListenerUpdate.cs @@ -21,8 +21,9 @@ namespace Wallee.Model public partial class AbstractWebhookListenerUpdate : IEquatable { /// - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public CreationEntityState? State { get; set; } /// diff --git a/src/Wallee/Model/AbstractWebhookUrlUpdate.cs b/src/Wallee/Model/AbstractWebhookUrlUpdate.cs index 3453376..eeca3f6 100644 --- a/src/Wallee/Model/AbstractWebhookUrlUpdate.cs +++ b/src/Wallee/Model/AbstractWebhookUrlUpdate.cs @@ -21,8 +21,9 @@ namespace Wallee.Model public partial class AbstractWebhookUrlUpdate : IEquatable { /// - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public CreationEntityState? State { get; set; } /// diff --git a/src/Wallee/Model/Account.cs b/src/Wallee/Model/Account.cs index 80a8e28..68ee77c 100644 --- a/src/Wallee/Model/Account.cs +++ b/src/Wallee/Model/Account.cs @@ -21,8 +21,9 @@ namespace Wallee.Model public partial class Account : IEquatable { /// - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public AccountState? State { get; private set; } /// @@ -82,15 +83,16 @@ public Account() public DateTime? DeletedOn { get; private set; } /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. [DataMember(Name="id", EmitDefaultValue=false)] public long? Id { get; private set; } /// - /// Gets or Sets LastModifiedDate + /// The date and time when the object was last modified. /// + /// The date and time when the object was last modified. [DataMember(Name="lastModifiedDate", EmitDefaultValue=false)] public DateTime? LastModifiedDate { get; private set; } @@ -109,9 +111,9 @@ public Account() public Account ParentAccount { get; private set; } /// - /// The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed. + /// The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed. /// - /// The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed. + /// The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed. [DataMember(Name="plannedPurgeDate", EmitDefaultValue=false)] public DateTime? PlannedPurgeDate { get; private set; } @@ -139,9 +141,9 @@ public Account() /// - /// The version number indicates the version of the entity. The version is incremented whenever the entity is changed. + /// The version is used for optimistic locking and incremented whenever the object is updated. /// - /// The version number indicates the version of the entity. The version is incremented whenever the entity is changed. + /// The version is used for optimistic locking and incremented whenever the object is updated. [DataMember(Name="version", EmitDefaultValue=false)] public int? Version { get; private set; } diff --git a/src/Wallee/Model/AnalyticsQueryExecution.cs b/src/Wallee/Model/AnalyticsQueryExecution.cs index 1cfc119..c0f1829 100644 --- a/src/Wallee/Model/AnalyticsQueryExecution.cs +++ b/src/Wallee/Model/AnalyticsQueryExecution.cs @@ -56,9 +56,9 @@ public AnalyticsQueryExecution() public FailureReason FailureReason { get; private set; } /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. [DataMember(Name="id", EmitDefaultValue=false)] public long? Id { get; private set; } diff --git a/src/Wallee/Model/BankAccount.cs b/src/Wallee/Model/BankAccount.cs index e4cb8c3..6e36f05 100644 --- a/src/Wallee/Model/BankAccount.cs +++ b/src/Wallee/Model/BankAccount.cs @@ -21,8 +21,9 @@ namespace Wallee.Model public partial class BankAccount : IEquatable { /// - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public BankAccountState? State { get; private set; } /// @@ -41,9 +42,9 @@ public BankAccount() public string Description { get; private set; } /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. [DataMember(Name="id", EmitDefaultValue=false)] public long? Id { get; private set; } @@ -55,16 +56,16 @@ public BankAccount() public string Identifier { get; private set; } /// - /// The linked space id holds the ID of the space to which the entity belongs to. + /// The ID of the space this object belongs to. /// - /// The linked space id holds the ID of the space to which the entity belongs to. + /// The ID of the space this object belongs to. [DataMember(Name="linkedSpaceId", EmitDefaultValue=false)] public long? LinkedSpaceId { get; private set; } /// - /// The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed. + /// The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed. /// - /// The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed. + /// The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed. [DataMember(Name="plannedPurgeDate", EmitDefaultValue=false)] public DateTime? PlannedPurgeDate { get; private set; } @@ -76,9 +77,9 @@ public BankAccount() public long? Type { get; private set; } /// - /// The version number indicates the version of the entity. The version is incremented whenever the entity is changed. + /// The version is used for optimistic locking and incremented whenever the object is updated. /// - /// The version number indicates the version of the entity. The version is incremented whenever the entity is changed. + /// The version is used for optimistic locking and incremented whenever the object is updated. [DataMember(Name="version", EmitDefaultValue=false)] public int? Version { get; private set; } diff --git a/src/Wallee/Model/BankAccountType.cs b/src/Wallee/Model/BankAccountType.cs index 58e79d7..11a669e 100644 --- a/src/Wallee/Model/BankAccountType.cs +++ b/src/Wallee/Model/BankAccountType.cs @@ -29,15 +29,16 @@ public BankAccountType() } /// - /// Gets or Sets Description + /// The description of the object translated into different languages. /// + /// The description of the object translated into different languages. [DataMember(Name="description", EmitDefaultValue=false)] public Dictionary Description { get; private set; } /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. [DataMember(Name="id", EmitDefaultValue=false)] public long? Id { get; private set; } @@ -48,8 +49,9 @@ public BankAccountType() public Dictionary IdentifierName { get; private set; } /// - /// Gets or Sets Name + /// The name of the object translated into different languages. /// + /// The name of the object translated into different languages. [DataMember(Name="name", EmitDefaultValue=false)] public Dictionary Name { get; private set; } diff --git a/src/Wallee/Model/BankTransaction.cs b/src/Wallee/Model/BankTransaction.cs index 49792d9..e447254 100644 --- a/src/Wallee/Model/BankTransaction.cs +++ b/src/Wallee/Model/BankTransaction.cs @@ -26,8 +26,9 @@ public partial class BankTransaction : IEquatable [DataMember(Name="flowDirection", EmitDefaultValue=false)] public BankTransactionFlowDirection? FlowDirection { get; private set; } /// - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public BankTransactionState? State { get; private set; } /// @@ -53,9 +54,9 @@ public BankTransaction() public long? CreatedBy { get; private set; } /// - /// The created on date indicates the date on which the entity was stored into the database. + /// The date and time when the object was created. /// - /// The created on date indicates the date on which the entity was stored into the database. + /// The date and time when the object was created. [DataMember(Name="createdOn", EmitDefaultValue=false)] public DateTime? CreatedOn { get; private set; } @@ -74,23 +75,23 @@ public BankTransaction() /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. [DataMember(Name="id", EmitDefaultValue=false)] public long? Id { get; private set; } /// - /// The linked space id holds the ID of the space to which the entity belongs to. + /// The ID of the space this object belongs to. /// - /// The linked space id holds the ID of the space to which the entity belongs to. + /// The ID of the space this object belongs to. [DataMember(Name="linkedSpaceId", EmitDefaultValue=false)] public long? LinkedSpaceId { get; private set; } /// - /// The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed. + /// The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed. /// - /// The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed. + /// The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed. [DataMember(Name="plannedPurgeDate", EmitDefaultValue=false)] public DateTime? PlannedPurgeDate { get; private set; } @@ -140,9 +141,9 @@ public BankTransaction() public DateTime? ValueDate { get; private set; } /// - /// The version number indicates the version of the entity. The version is incremented whenever the entity is changed. + /// The version is used for optimistic locking and incremented whenever the object is updated. /// - /// The version number indicates the version of the entity. The version is incremented whenever the entity is changed. + /// The version is used for optimistic locking and incremented whenever the object is updated. [DataMember(Name="version", EmitDefaultValue=false)] public int? Version { get; private set; } diff --git a/src/Wallee/Model/BankTransactionSource.cs b/src/Wallee/Model/BankTransactionSource.cs index ee3c34c..2627289 100644 --- a/src/Wallee/Model/BankTransactionSource.cs +++ b/src/Wallee/Model/BankTransactionSource.cs @@ -29,21 +29,23 @@ public BankTransactionSource() } /// - /// Gets or Sets Description + /// The description of the object translated into different languages. /// + /// The description of the object translated into different languages. [DataMember(Name="description", EmitDefaultValue=false)] public Dictionary Description { get; private set; } /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. [DataMember(Name="id", EmitDefaultValue=false)] public long? Id { get; private set; } /// - /// Gets or Sets Name + /// The name of the object translated into different languages. /// + /// The name of the object translated into different languages. [DataMember(Name="name", EmitDefaultValue=false)] public Dictionary Name { get; private set; } diff --git a/src/Wallee/Model/BankTransactionType.cs b/src/Wallee/Model/BankTransactionType.cs index 76c7370..fd09699 100644 --- a/src/Wallee/Model/BankTransactionType.cs +++ b/src/Wallee/Model/BankTransactionType.cs @@ -29,21 +29,23 @@ public BankTransactionType() } /// - /// Gets or Sets Description + /// The description of the object translated into different languages. /// + /// The description of the object translated into different languages. [DataMember(Name="description", EmitDefaultValue=false)] public Dictionary Description { get; private set; } /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. /// - /// The ID is the primary key of the entity. The ID identifies the entity uniquely. + /// A unique identifier for the object. [DataMember(Name="id", EmitDefaultValue=false)] public long? Id { get; private set; } /// - /// Gets or Sets Name + /// The name of the object translated into different languages. /// + /// The name of the object translated into different languages. [DataMember(Name="name", EmitDefaultValue=false)] public Dictionary Name { get; private set; } diff --git a/src/Wallee/Model/Charge.cs b/src/Wallee/Model/Charge.cs index 458871e..2275a53 100644 --- a/src/Wallee/Model/Charge.cs +++ b/src/Wallee/Model/Charge.cs @@ -21,8 +21,9 @@ namespace Wallee.Model public partial class Charge : TransactionAwareEntity, IEquatable { /// - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public ChargeState? State { get; private set; } /// @@ -55,15 +56,16 @@ public Charge() public FailureReason FailureReason { get; private set; } /// - /// Gets or Sets Language + /// The language that is linked to the object. /// + /// The language that is linked to the object. [DataMember(Name="language", EmitDefaultValue=false)] public string Language { get; private set; } /// - /// The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed. + /// The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed. /// - /// The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed. + /// The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed. [DataMember(Name="plannedPurgeDate", EmitDefaultValue=false)] public DateTime? PlannedPurgeDate { get; private set; } @@ -101,9 +103,9 @@ public Charge() public string UserFailureMessage { get; private set; } /// - /// The version number indicates the version of the entity. The version is incremented whenever the entity is changed. + /// The version is used for optimistic locking and incremented whenever the object is updated. /// - /// The version number indicates the version of the entity. The version is incremented whenever the entity is changed. + /// The version is used for optimistic locking and incremented whenever the object is updated. [DataMember(Name="version", EmitDefaultValue=false)] public int? Version { get; private set; } diff --git a/src/Wallee/Model/ChargeAttempt.cs b/src/Wallee/Model/ChargeAttempt.cs index 462b1cc..ce962a9 100644 --- a/src/Wallee/Model/ChargeAttempt.cs +++ b/src/Wallee/Model/ChargeAttempt.cs @@ -37,8 +37,9 @@ public partial class ChargeAttempt : TransactionAwareEntity, IEquatable - /// Gets or Sets State + /// The object's current state. /// + /// The object's current state. [DataMember(Name="state", EmitDefaultValue=false)] public ChargeAttemptState? State { get; private set; } /// @@ -71,9 +72,9 @@ public ChargeAttempt() public PaymentConnectorConfiguration ConnectorConfiguration { get; private set; } /// - /// The created on date indicates the date on which the entity was stored into the database. + /// The date and time when the object was created. /// - /// The created on date indicates the date on which the entity was stored into the database. + /// The date and time when the object was created. [DataMember(Name="createdOn", EmitDefaultValue=false)] public DateTime? CreatedOn { get; private set; } @@ -110,8 +111,9 @@ public ChargeAttempt() public List