Skip to content

Commit b43faee

Browse files
Merge main -> oas-release (#498)
2 parents 60bc277 + b4b298a commit b43faee

65 files changed

Lines changed: 1623 additions & 63 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

openapi-raw.yaml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7697,7 +7697,7 @@ components:
76977697
type: array
76987698
items:
76997699
type: string
7700-
maxItems: 2
7700+
maxItems: 10
77017701
minItems: 1
77027702
name:
77037703
description: '_t__ApiAppCreate::NAME'
@@ -7723,7 +7723,7 @@ components:
77237723
type: array
77247724
items:
77257725
type: string
7726-
maxItems: 2
7726+
maxItems: 10
77277727
name:
77287728
description: '_t__ApiAppUpdate::NAME'
77297729
type: string
@@ -8021,6 +8021,7 @@ components:
80218021
enum:
80228022
- user_activity
80238023
- document_status
8024+
- sms_activity
80248025
maxItems: 2
80258026
minItems: 1
80268027
start_date:
@@ -11224,6 +11225,7 @@ components:
1122411225
enum:
1122511226
- user_activity
1122611227
- document_status
11228+
- sms_activity
1122711229
type: object
1122811230
x-internal-class: true
1122911231
SignatureRequestResponse:
@@ -12286,6 +12288,14 @@ components:
1228612288
- employer_identification_number
1228712289
- custom_regex
1228812290
nullable: true
12291+
validation_custom_regex:
12292+
description: '_t__TemplateResponseDocumentFormField::CUSTOM_REGEX'
12293+
type: string
12294+
nullable: true
12295+
validation_custom_regex_format_label:
12296+
description: '_t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL'
12297+
type: string
12298+
nullable: true
1228912299
group:
1229012300
description: '_t__TemplateResponseDocumentFormField::GROUP'
1229112301
type: string

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

openapi.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:
@@ -11942,6 +11943,7 @@ components:
1194211943
enum:
1194311944
- user_activity
1194411945
- document_status
11946+
- sms_activity
1194511947
type: object
1194611948
x-internal-class: true
1194711949
SignatureRequestResponse:
@@ -13108,6 +13110,14 @@ components:
1310813110
- employer_identification_number
1310913111
- custom_regex
1311013112
nullable: true
13113+
validation_custom_regex:
13114+
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.'
13115+
type: string
13116+
nullable: true
13117+
validation_custom_regex_format_label:
13118+
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.'
13119+
type: string
13120+
nullable: true
1311113121
group:
1311213122
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.'
1311313123
type: string

sdks/dotnet/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

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+
}
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+
}

sdks/dotnet/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>

sdks/dotnet/src/Dropbox.Sign/Model/ReportResponse.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)