Skip to content

Commit cbae9fa

Browse files
shuyckshuyck
authored
release 2.1.0 (#19)
1 parent 285de5a commit cbae9fa

19 files changed

+282
-33
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ directory that corresponds to the file you want updated.
2323
This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
2424

2525
- API version: 3.0.0
26-
- SDK version: 2.0.0
26+
- SDK version: 2.1.0
2727
- Generator version: 7.12.0
2828
- Build package: org.openapitools.codegen.languages.CSharpClientCodegen
2929

‎VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.0.0
1+
2.1.0

‎docs/TemplateResponseDocumentFormFieldText.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
1313
**Width** | **int** | The width in pixels of this form field. | [optional]
1414
**Height** | **int** | The height in pixels of this form field. | [optional]
1515
**Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
16-
**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field&#39;s text. | [optional] **FontFamily** | **string** | Font family used in this form field&#39;s text. | [optional] **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
16+
**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field&#39;s text. | [optional] **FontFamily** | **string** | Font family used in this form field&#39;s text. | [optional] **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | [optional] **ValidationCustomRegex** | **string** | When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. | [optional] **ValidationCustomRegexFormatLabel** | **string** | When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
1717

1818
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1919

‎openapi-config.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ additionalProperties:
66
packageCompany: Dropbox Sign API Team
77
packageCopyright: Dropbox 2024
88
packageDescription: Client library for using the Dropbox Sign API
9-
packageVersion: 2.0.0
9+
packageVersion: 2.1.0
1010
packageTitle: Dropbox Sign .Net SDK
1111
sortModelPropertiesByRequiredFlag: true
1212
optionalEmitDefaultValues: true

‎openapi-sdk.yaml‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7797,7 +7797,7 @@ components:
77977797
type: array
77987798
items:
77997799
type: string
7800-
maxItems: 2
7800+
maxItems: 10
78017801
minItems: 1
78027802
name:
78037803
description: 'The name you want to assign to the ApiApp.'
@@ -7823,7 +7823,7 @@ components:
78237823
type: array
78247824
items:
78257825
type: string
7826-
maxItems: 2
7826+
maxItems: 10
78277827
name:
78287828
description: 'The name you want to assign to the ApiApp.'
78297829
type: string
@@ -8135,6 +8135,7 @@ components:
81358135
enum:
81368136
- user_activity
81378137
- document_status
8138+
- sms_activity
81388139
maxItems: 2
81398140
minItems: 1
81408141
start_date:
@@ -11964,6 +11965,7 @@ components:
1196411965
enum:
1196511966
- user_activity
1196611967
- document_status
11968+
- sms_activity
1196711969
type: object
1196811970
x-internal-class: true
1196911971
SignatureRequestResponse:
@@ -13130,6 +13132,14 @@ components:
1313013132
- employer_identification_number
1313113133
- custom_regex
1313213134
nullable: true
13135+
validation_custom_regex:
13136+
description: 'When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field.'
13137+
type: string
13138+
nullable: true
13139+
validation_custom_regex_format_label:
13140+
description: 'When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.'
13141+
type: string
13142+
nullable: true
1313313143
group:
1313413144
description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
1313513145
type: string

‎src/Dropbox.Sign.Test/Api/FaxApiTests.cs‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.IO;
4+
using Xunit;
5+
using System.Text.Json;
6+
7+
using Dropbox.Sign.Api;
8+
using Dropbox.Sign.Model;
9+
10+
namespace Dropbox.Sign.Test.Api
11+
{
12+
public class FaxApiTests
13+
{
14+
[Fact]
15+
public void SendFaxTest()
16+
{
17+
var requestData = TestHelper.GetJsonContents(nameof(FaxSendRequest));
18+
var responseData = TestHelper.GetJsonContents(nameof(FaxGetResponse));
19+
20+
var obj = FaxSendRequest.Init(
21+
requestData.ToString()
22+
);
23+
24+
obj.Files = new List<Stream> {
25+
new FileStream(
26+
TestHelper.RootPath + "/pdf-sample.pdf",
27+
FileMode.Open,
28+
FileAccess.Read,
29+
FileShare.Read
30+
)
31+
};
32+
33+
var responseObj = FaxGetResponse.Init(responseData.ToString());
34+
35+
var api = MockRestClientHelper.CreateApiExpectMultiFormRequest<FaxGetResponse, FaxApi>(responseObj);
36+
var response = api.FaxSend(obj);
37+
38+
TestHelper.AssertJsonSame(responseData.ToString(), response.ToJson());
39+
}
40+
41+
[Fact]
42+
public void FaxListTest()
43+
{
44+
var responseData = TestHelper.GetJsonContents(nameof(FaxListResponse));
45+
46+
var api = MockRestClientHelper.CreateApi<FaxApi>(responseData);
47+
var response = api.FaxList();
48+
49+
TestHelper.AssertJsonSame(responseData.ToString(), response.ToJson());
50+
}
51+
52+
[Fact]
53+
public void FaxGetTest()
54+
{
55+
var faxId = "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d";
56+
57+
var responseData = TestHelper.GetJsonContents(nameof(FaxGetResponse));
58+
59+
var api = MockRestClientHelper.CreateApi<FaxApi>(responseData);
60+
var response = api.FaxGet(faxId);
61+
62+
TestHelper.AssertJsonSame(responseData.ToString(), response.ToJson());
63+
}
64+
}
65+
}

‎src/Dropbox.Sign.Test/Api/FaxLineApiTests.cs‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.IO;
4+
using Xunit;
5+
using System.Text.Json;
6+
7+
using Dropbox.Sign.Api;
8+
using Dropbox.Sign.Model;
9+
10+
namespace Dropbox.Sign.Test.Api
11+
{
12+
public class FaxLineApiTests
13+
{
14+
[Fact]
15+
public void FaxLineCreateTest()
16+
{
17+
var requestData = TestHelper.GetJsonContents(nameof(FaxLineCreateRequest));
18+
var responseData = TestHelper.GetJsonContents(nameof(FaxLineResponse));
19+
20+
var obj = FaxLineCreateRequest.Init(
21+
requestData.ToString()
22+
);
23+
24+
var api = MockRestClientHelper.CreateApi<FaxLineApi>(responseData);
25+
var response = api.FaxLineCreate(obj);
26+
27+
TestHelper.AssertJsonSame(responseData.ToString(), response.ToJson());
28+
}
29+
30+
[Fact]
31+
public void FaxLineListTest()
32+
{
33+
var responseData = TestHelper.GetJsonContents(nameof(FaxLineListResponse));
34+
35+
var api = MockRestClientHelper.CreateApi<FaxLineApi>(responseData);
36+
var response = api.FaxLineList();
37+
38+
TestHelper.AssertJsonSame(responseData.ToString(), response.ToJson());
39+
}
40+
41+
[Fact]
42+
public void FaxLineGetTest()
43+
{
44+
var faxLineNumber = "14155557897";
45+
46+
var responseData = TestHelper.GetJsonContents(nameof(FaxLineResponse));
47+
48+
var api = MockRestClientHelper.CreateApi<FaxLineApi>(responseData);
49+
var response = api.FaxLineGet(faxLineNumber);
50+
51+
TestHelper.AssertJsonSame(responseData.ToString(), response.ToJson());
52+
}
53+
}
54+
}

‎src/Dropbox.Sign/Client/Configuration.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public class Configuration : IReadableConfiguration
3636
/// Version of the package.
3737
/// </summary>
3838
/// <value>Version of the package.</value>
39-
public const string Version = "2.0.0";
39+
public const string Version = "2.1.0";
4040

4141
/// <summary>
4242
/// Identifier for ISO 8601 DateTime Format
@@ -120,7 +120,7 @@ public class Configuration : IReadableConfiguration
120120
public Configuration()
121121
{
122122
Proxy = null;
123-
UserAgent = WebUtility.UrlEncode("OpenAPI-Generator/2.0.0/csharp");
123+
UserAgent = WebUtility.UrlEncode("OpenAPI-Generator/2.1.0/csharp");
124124
BasePath = "https://api.hellosign.com/v3";
125125
DefaultHeaders = new ConcurrentDictionary<string, string>();
126126
ApiKey = new ConcurrentDictionary<string, string>();
@@ -567,7 +567,7 @@ public static string ToDebugReport()
567567
report += " OS: " + System.Environment.OSVersion + "\n";
568568
report += " .NET Framework Version: " + System.Environment.Version + "\n";
569569
report += " Version of the API: 3.0.0\n";
570-
report += " SDK Package Version: 2.0.0\n";
570+
report += " SDK Package Version: 2.1.0\n";
571571

572572
return report;
573573
}

‎src/Dropbox.Sign/Dropbox.Sign.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<Description>Client library for using the Dropbox Sign API</Description>
1313
<Copyright>Dropbox 2024</Copyright>
1414
<RootNamespace>Dropbox.Sign</RootNamespace>
15-
<Version>2.0.0</Version>
15+
<Version>2.1.0</Version>
1616
<DocumentationFile>bin\$(Configuration)\$(TargetFramework)\Dropbox.Sign.xml</DocumentationFile>
1717
<RepositoryUrl>https://github.com/hellosign/dropbox-sign-dotnet.git</RepositoryUrl>
1818
<RepositoryType>git</RepositoryType>

‎src/Dropbox.Sign/Model/ReportCreateRequest.cs‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,13 @@ public enum ReportTypeEnum
4949
/// Enum DocumentStatus for value: document_status
5050
/// </summary>
5151
[EnumMember(Value = "document_status")]
52-
DocumentStatus = 2
52+
DocumentStatus = 2,
53+
54+
/// <summary>
55+
/// Enum SmsActivity for value: sms_activity
56+
/// </summary>
57+
[EnumMember(Value = "sms_activity")]
58+
SmsActivity = 3
5359
}
5460

5561
/// <summary>

0 commit comments

Comments
 (0)