Skip to content

Commit

Permalink
docs: remove parameter from Sign page (box/box-openapi#489)
Browse files Browse the repository at this point in the history
  • Loading branch information
box-sdk-build committed Dec 17, 2024
1 parent f1fae3e commit 65775b2
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "3799ab4", "specHash": "c9d7bb5", "version": "1.5.0" }
{ "engineHash": "264bdc9", "specHash": "6886603", "version": "1.5.0" }
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public async System.Threading.Tasks.Task TestCreateGetCancelAndListSignRequest()
string signerEmail = string.Concat(Utils.GetUUID(), "@box.com");
FileFull fileToSign = await new CommonsManager().UploadNewFileAsync();
FolderFull destinationFolder = await new CommonsManager().CreateNewFolderAsync();
SignRequest createdSignRequest = await client.SignRequests.CreateSignRequestAsync(requestBody: new SignRequestCreateRequest(signers: Array.AsReadOnly(new [] {new SignRequestCreateSigner() { Email = signerEmail, SuppressNotifications = true, DeclinedRedirectUrl = "https://www.box.com", EmbedUrlExternalUserId = "123", IsInPerson = false, LoginRequired = false, Password = "password", Role = SignRequestCreateSignerRoleField.Signer }})) { AreRemindersEnabled = true, AreTextSignaturesEnabled = true, DaysValid = 30, DeclinedRedirectUrl = "https://www.box.com", EmailMessage = "Please sign this document", EmailSubject = "Sign this document", ExternalId = "123", ExternalSystemName = "BoxSignIntegration", IsDocumentPreparationNeeded = false, IsPhoneVerificationRequiredToView = false, Name = "Sign Request", ParentFolder = new FolderMini(id: destinationFolder.Id), RedirectUrl = "https://www.box.com", PrefillTags = Array.AsReadOnly(new [] {new SignRequestPrefillTag() { DateValue = Utils.DateFromString(date: "2035-01-01"), DocumentTagId = "0" }}), SourceFiles = Array.AsReadOnly(new [] {new FileBase(id: fileToSign.Id)}) });
SignRequest createdSignRequest = await client.SignRequests.CreateSignRequestAsync(requestBody: new SignRequestCreateRequest(signers: Array.AsReadOnly(new [] {new SignRequestCreateSigner() { Email = signerEmail, SuppressNotifications = true, DeclinedRedirectUrl = "https://www.box.com", EmbedUrlExternalUserId = "123", IsInPerson = false, LoginRequired = false, Password = "password", Role = SignRequestCreateSignerRoleField.Signer }})) { AreRemindersEnabled = true, AreTextSignaturesEnabled = true, DaysValid = 30, DeclinedRedirectUrl = "https://www.box.com", EmailMessage = "Please sign this document", EmailSubject = "Sign this document", ExternalId = "123", ExternalSystemName = "BoxSignIntegration", IsDocumentPreparationNeeded = false, Name = "Sign Request", ParentFolder = new FolderMini(id: destinationFolder.Id), RedirectUrl = "https://www.box.com", PrefillTags = Array.AsReadOnly(new [] {new SignRequestPrefillTag() { DateValue = Utils.DateFromString(date: "2035-01-01"), DocumentTagId = "0" }}), SourceFiles = Array.AsReadOnly(new [] {new FileBase(id: fileToSign.Id)}) });
Assert.IsTrue(createdSignRequest.AreRemindersEnabled == true);
Assert.IsTrue(createdSignRequest.AreTextSignaturesEnabled == true);
Assert.IsTrue(createdSignRequest.DaysValid == 30);
Expand All @@ -30,7 +30,6 @@ public async System.Threading.Tasks.Task TestCreateGetCancelAndListSignRequest()
Assert.IsTrue(createdSignRequest.ExternalId == "123");
Assert.IsTrue(createdSignRequest.ExternalSystemName == "BoxSignIntegration");
Assert.IsTrue(createdSignRequest.IsDocumentPreparationNeeded == false);
Assert.IsTrue(createdSignRequest.IsPhoneVerificationRequiredToView == false);
Assert.IsTrue(createdSignRequest.Name == "Sign Request");
Assert.IsTrue(createdSignRequest.RedirectUrl == "https://www.box.com");
Assert.IsTrue(NullableUtils.Unwrap(NullableUtils.Unwrap(createdSignRequest.SignFiles).Files)[0].Name == fileToSign.Name);
Expand Down
12 changes: 12 additions & 0 deletions Box.Sdk.Gen/Schemas/Event/EventEventTypeField.cs
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,18 @@ public enum EventEventTypeField {
Edit,
[Description("EDIT_USER")]
EditUser,
[Description("EDR_CROWDSTRIKE_DEVICE_DETECTED")]
EdrCrowdstrikeDeviceDetected,
[Description("EDR_CROWDSTRIKE_NO_BOX_TOOLS")]
EdrCrowdstrikeNoBoxTools,
[Description("EDR_CROWDSTRIKE_BOX_TOOLS_OUTDATED")]
EdrCrowdstrikeBoxToolsOutdated,
[Description("EDR_CROWDSTRIKE_DRIVE_OUTDATED")]
EdrCrowdstrikeDriveOutdated,
[Description("EDR_CROWDSTRIKE_ACCESS_ALLOWED_NO_CROWDSTRIKE_DEVICE")]
EdrCrowdstrikeAccessAllowedNoCrowdstrikeDevice,
[Description("EDR_CROWDSTRIKE_ACCESS_REVOKED")]
EdrCrowdstrikeAccessRevoked,
[Description("EMAIL_ALIAS_CONFIRM")]
EmailAliasConfirm,
[Description("EMAIL_ALIAS_REMOVE")]
Expand Down
12 changes: 0 additions & 12 deletions Box.Sdk.Gen/Schemas/SignRequestBase/SignRequestBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,6 @@ public class SignRequestBase : ISerializable {
[JsonPropertyName("_isexternal_idSet")]
protected bool _isExternalIdSet { get; set; }

[JsonInclude]
[JsonPropertyName("_isis_phone_verification_required_to_viewSet")]
protected bool _isIsPhoneVerificationRequiredToViewSet { get; set; }

[JsonInclude]
[JsonPropertyName("_istemplate_idSet")]
protected bool _isTemplateIdSet { get; set; }
Expand All @@ -56,8 +52,6 @@ public class SignRequestBase : ISerializable {

protected string? _externalId { get; set; }

protected bool? _isPhoneVerificationRequiredToView { get; set; }

protected string? _templateId { get; set; }

protected string? _externalSystemName { get; set; }
Expand Down Expand Up @@ -128,12 +122,6 @@ public class SignRequestBase : ISerializable {
[JsonPropertyName("external_id")]
public string? ExternalId { get => _externalId; init { _externalId = value; _isExternalIdSet = true; } }

/// <summary>
/// Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them.
/// </summary>
[JsonPropertyName("is_phone_verification_required_to_view")]
public bool? IsPhoneVerificationRequiredToView { get => _isPhoneVerificationRequiredToView; init { _isPhoneVerificationRequiredToView = value; _isIsPhoneVerificationRequiredToViewSet = true; } }

/// <summary>
/// When a signature request is created from a template this field will indicate the id of that template.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@ public class SignRequestCreateSigner : ISerializable {
[JsonPropertyName("_islogin_requiredSet")]
protected bool _isLoginRequiredSet { get; set; }

[JsonInclude]
[JsonPropertyName("_isverification_phone_numberSet")]
protected bool _isVerificationPhoneNumberSet { get; set; }

[JsonInclude]
[JsonPropertyName("_ispasswordSet")]
protected bool _isPasswordSet { get; set; }
Expand All @@ -51,8 +47,6 @@ public class SignRequestCreateSigner : ISerializable {

protected bool? _loginRequired { get; set; }

protected string? _verificationPhoneNumber { get; set; }

protected string? _password { get; set; }

protected string? _signerGroupId { get; set; }
Expand Down Expand Up @@ -120,20 +114,11 @@ public class SignRequestCreateSigner : ISerializable {
/// If set to true, the signer will need to log in to a Box account
/// before signing the request. If the signer does not have
/// an existing account, they will have the option to create
/// a free Box account. Cannot be selected in combination with
/// `verification_phone_number`.
/// a free Box account.
/// </summary>
[JsonPropertyName("login_required")]
public bool? LoginRequired { get => _loginRequired; init { _loginRequired = value; _isLoginRequiredSet = true; } }

/// <summary>
/// If set, this phone number will be used to verify the signer
/// via two-factor authentication before they are able to sign the document.
/// Cannot be selected in combination with `login_required`.
/// </summary>
[JsonPropertyName("verification_phone_number")]
public string? VerificationPhoneNumber { get => _verificationPhoneNumber; init { _verificationPhoneNumber = value; _isVerificationPhoneNumberSet = true; } }

/// <summary>
/// If set, the signer is required to enter the password before they are able
/// to sign a document. This field is write only.
Expand Down

0 comments on commit 65775b2

Please sign in to comment.