diff --git a/.codegen.json b/.codegen.json index 4f3ed7d0..22250871 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "3eadef2", "specHash": "98bca8f", "version": "0.3.1" } +{ "engineHash": "3eadef2", "specHash": "f26f46d", "version": "0.3.1" } diff --git a/Box.Sdk.Gen/Managers/SignRequests/SignRequestsManager.cs b/Box.Sdk.Gen/Managers/SignRequests/SignRequestsManager.cs index 2de369d6..3a4b1bbc 100644 --- a/Box.Sdk.Gen/Managers/SignRequests/SignRequestsManager.cs +++ b/Box.Sdk.Gen/Managers/SignRequests/SignRequestsManager.cs @@ -21,7 +21,7 @@ public SignRequestsManager(NetworkSession networkSession = default) { /// Cancels a sign request. /// /// - /// The ID of the sign request + /// The ID of the signature request /// Example: "33243242" /// /// @@ -38,10 +38,10 @@ public async System.Threading.Tasks.Task CancelSignRequestAsync(str } /// - /// Resends a sign request email to all outstanding signers. + /// Resends a signature request email to all outstanding signers. /// /// - /// The ID of the sign request + /// The ID of the signature request /// Example: "33243242" /// /// @@ -60,7 +60,7 @@ public async System.Threading.Tasks.Task ResendSignRequestAsync(string signReque /// Gets a sign request by ID. /// /// - /// The ID of the sign request + /// The ID of the signature request /// Example: "33243242" /// /// @@ -77,8 +77,8 @@ public async System.Threading.Tasks.Task GetSignRequestByIdAsync(st } /// - /// Gets sign requests created by a user. If the `sign_files` and/or - /// `parent_folder` are deleted, the sign request will not return in the list. + /// Gets signature requests created by a user. If the `sign_files` and/or + /// `parent_folder` are deleted, the signature request will not return in the list. /// /// /// Query parameters of getSignRequests method @@ -99,8 +99,8 @@ public async System.Threading.Tasks.Task GetSignRequestsAsync(GetS } /// - /// Creates a sign request. This involves preparing a document for signing and - /// sending the sign request to signers. + /// Creates a signature request. This involves preparing a document for signing and + /// sending the signature request to signers. /// /// /// Request body of createSignRequest method diff --git a/Box.Sdk.Gen/Schemas/SignRequest/SignRequest.cs b/Box.Sdk.Gen/Schemas/SignRequest/SignRequest.cs index b0498c1d..6b9bd4b3 100644 --- a/Box.Sdk.Gen/Schemas/SignRequest/SignRequest.cs +++ b/Box.Sdk.Gen/Schemas/SignRequest/SignRequest.cs @@ -20,7 +20,7 @@ public class SignRequest : SignRequestBase { public IReadOnlyList? SourceFiles { get; set; } = default; /// - /// Array of signers for the sign request + /// Array of signers for the signature request. /// [JsonPropertyName("signers")] public IReadOnlyList? Signers { get; set; } = default; @@ -32,15 +32,16 @@ public class SignRequest : SignRequestBase { public string? SignatureColor { get; set; } = default; /// - /// Sign request ID + /// Box Sign request ID. /// [JsonPropertyName("id")] public string? Id { get; set; } = default; /// /// This URL is returned if `is_document_preparation_needed` is - /// set to `true` in the request. It is used to prepare the sign request - /// via UI. The sign request is not sent until preparation is complete. + /// set to `true` for Box Sign request. It is used to prepare a signature request + /// using the UI. The signature request is not sent until the preparation + /// phase is complete. /// [JsonPropertyName("prepare_url")] public string? PrepareUrl { get; set; } = default; @@ -49,7 +50,7 @@ public class SignRequest : SignRequestBase { public FileMini? SigningLog { get; set; } = default; /// - /// Describes the status of the sign request + /// Describes the status of the signature request. /// [JsonPropertyName("status")] public SignRequestStatusField? Status { get; set; } = default; diff --git a/Box.Sdk.Gen/Schemas/SignRequestBase/SignRequestBase.cs b/Box.Sdk.Gen/Schemas/SignRequestBase/SignRequestBase.cs index 6d684cf6..4e798b31 100644 --- a/Box.Sdk.Gen/Schemas/SignRequestBase/SignRequestBase.cs +++ b/Box.Sdk.Gen/Schemas/SignRequestBase/SignRequestBase.cs @@ -8,13 +8,13 @@ namespace Box.Sdk.Gen.Schemas { public class SignRequestBase { /// - /// Indicates if the sender should receive a `prepare_url` in the response to complete document preparation via UI. + /// Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI. /// [JsonPropertyName("is_document_preparation_needed")] public bool? IsDocumentPreparationNeeded { get; set; } = default; /// - /// When specified, signature request will be redirected to this url when a document is signed. + /// When specified, the signature request will be redirected to this url when a document is signed. /// [JsonPropertyName("redirect_url")] public string? RedirectUrl { get; set; } = default; @@ -50,13 +50,13 @@ public class SignRequestBase { public bool? AreRemindersEnabled { get; set; } = default; /// - /// Name of the sign request. + /// Name of the signature request. /// [JsonPropertyName("name")] public string? Name { get; set; } = default; /// - /// When a document contains sign related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag. + /// When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag. /// [JsonPropertyName("prefill_tags")] public IReadOnlyList? PrefillTags { get; set; } = default; diff --git a/Box.Sdk.Gen/Schemas/SignRequestCreateRequest/SignRequestCreateRequest.cs b/Box.Sdk.Gen/Schemas/SignRequestCreateRequest/SignRequestCreateRequest.cs index 005bc38a..46da19e8 100644 --- a/Box.Sdk.Gen/Schemas/SignRequestCreateRequest/SignRequestCreateRequest.cs +++ b/Box.Sdk.Gen/Schemas/SignRequestCreateRequest/SignRequestCreateRequest.cs @@ -20,7 +20,7 @@ public class SignRequestCreateRequest : SignRequestBase { public SignRequestCreateRequestSignatureColorField? SignatureColor { get; set; } = default; /// - /// Array of signers for the sign request. 35 is the max number of signers permitted. + /// Array of signers for the signature request. 35 is the max number of signers permitted. /// [JsonPropertyName("signers")] public IReadOnlyList Signers { get; set; } diff --git a/Box.Sdk.Gen/Schemas/SignRequestCreateSigner/SignRequestCreateSigner.cs b/Box.Sdk.Gen/Schemas/SignRequestCreateSigner/SignRequestCreateSigner.cs index e74f6320..c7552720 100644 --- a/Box.Sdk.Gen/Schemas/SignRequestCreateSigner/SignRequestCreateSigner.cs +++ b/Box.Sdk.Gen/Schemas/SignRequestCreateSigner/SignRequestCreateSigner.cs @@ -11,7 +11,7 @@ public class SignRequestCreateSigner { public string? Email { get; set; } = default; /// - /// Defines the role of the signer in the sign request. A `signer` + /// Defines the role of the signer in the signature request. A `signer` /// must sign the document and an `approver` must approve the document. A /// `final_copy_reader` only receives the final signed document and signing /// log. diff --git a/Box.Sdk.Gen/Schemas/SignRequestPrefillTag/SignRequestPrefillTag.cs b/Box.Sdk.Gen/Schemas/SignRequestPrefillTag/SignRequestPrefillTag.cs index 9a1c8f01..aa0290dd 100644 --- a/Box.Sdk.Gen/Schemas/SignRequestPrefillTag/SignRequestPrefillTag.cs +++ b/Box.Sdk.Gen/Schemas/SignRequestPrefillTag/SignRequestPrefillTag.cs @@ -4,7 +4,7 @@ namespace Box.Sdk.Gen.Schemas { public class SignRequestPrefillTag { /// - /// This references the ID of a specific tag contained in a file of the sign request. + /// This references the ID of a specific tag contained in a file of the signature request. /// [JsonPropertyName("document_tag_id")] public string? DocumentTagId { get; set; } = default; diff --git a/Box.Sdk.Gen/Schemas/SignRequestSigner/SignRequestSigner.cs b/Box.Sdk.Gen/Schemas/SignRequestSigner/SignRequestSigner.cs index a833848e..6d46c424 100644 --- a/Box.Sdk.Gen/Schemas/SignRequestSigner/SignRequestSigner.cs +++ b/Box.Sdk.Gen/Schemas/SignRequestSigner/SignRequestSigner.cs @@ -14,7 +14,7 @@ public class SignRequestSigner : SignRequestCreateSigner { public bool? HasViewedDocument { get; set; } = default; /// - /// Final decision made by the signer + /// Final decision made by the signer. /// [JsonPropertyName("signer_decision")] public SignRequestSignerSignerDecisionField? SignerDecision { get; set; } = default; @@ -34,7 +34,7 @@ public class SignRequestSigner : SignRequestCreateSigner { /// It will be returned in the response /// only if the `embed_url_external_user_id` /// parameter was passed in the - /// `create sign request` call. + /// `create Box Sign request` call. /// [JsonPropertyName("iframeable_embed_url")] public string? IframeableEmbedUrl { get; set; } = default; diff --git a/Box.Sdk.Gen/Schemas/SignRequestSigner/SignRequestSignerSignerDecisionField.cs b/Box.Sdk.Gen/Schemas/SignRequestSigner/SignRequestSignerSignerDecisionField.cs index 44cbcdd4..3e52b42d 100644 --- a/Box.Sdk.Gen/Schemas/SignRequestSigner/SignRequestSignerSignerDecisionField.cs +++ b/Box.Sdk.Gen/Schemas/SignRequestSigner/SignRequestSignerSignerDecisionField.cs @@ -5,19 +5,19 @@ namespace Box.Sdk.Gen.Schemas { public class SignRequestSignerSignerDecisionField { /// - /// Type of decision made by the signer + /// Type of decision made by the signer. /// [JsonPropertyName("type")] public SignRequestSignerSignerDecisionTypeField? Type { get; set; } = default; /// - /// Date and Time that the decision was made + /// Date and Time that the decision was made. /// [JsonPropertyName("finalized_at")] public System.DateTimeOffset? FinalizedAt { get; set; } = default; /// - /// Additional info about the decision, such as the decline reason from the signer + /// Additional info about the decision, such as the decline reason from the signer. /// [JsonPropertyName("additional_info")] public string? AdditionalInfo { get; set; } = default; diff --git a/Box.Sdk.Gen/Schemas/SignRequests/SignRequests.cs b/Box.Sdk.Gen/Schemas/SignRequests/SignRequests.cs index 2293d94a..3a759895 100644 --- a/Box.Sdk.Gen/Schemas/SignRequests/SignRequests.cs +++ b/Box.Sdk.Gen/Schemas/SignRequests/SignRequests.cs @@ -22,7 +22,7 @@ public class SignRequests { public string? NextMarker { get; set; } = default; /// - /// A list of sign requests + /// A list of Box Sign requests. /// [JsonPropertyName("entries")] public IReadOnlyList? Entries { get; set; } = default; diff --git a/Box.Sdk.Gen/Schemas/TemplateSigner/TemplateSigner.cs b/Box.Sdk.Gen/Schemas/TemplateSigner/TemplateSigner.cs index bfb16079..41e5f16e 100644 --- a/Box.Sdk.Gen/Schemas/TemplateSigner/TemplateSigner.cs +++ b/Box.Sdk.Gen/Schemas/TemplateSigner/TemplateSigner.cs @@ -43,7 +43,7 @@ public class TemplateSigner { /// /// If provided, this value points signers that are assigned the same inputs and belongs to same signer group. /// A signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used - /// within Sign Requests created from it. + /// within Box Sign requests created from it. /// [JsonPropertyName("signer_group_id")] public string? SignerGroupId { get; set; } = default; diff --git a/docs/SignRequests.md b/docs/SignRequests.md index 2323b840..b61f7fb2 100644 --- a/docs/SignRequests.md +++ b/docs/SignRequests.md @@ -1,13 +1,13 @@ # ISignRequestsManager -- [Cancel sign request](#cancel-sign-request) -- [Resend sign request](#resend-sign-request) -- [Get sign request by ID](#get-sign-request-by-id) -- [List sign requests](#list-sign-requests) -- [Create sign request](#create-sign-request) +- [Cancel Box Sign request](#cancel-box-sign-request) +- [Resend Box Sign request](#resend-box-sign-request) +- [Get Box Sign request by ID](#get-box-sign-request-by-id) +- [List Box Sign requests](#list-box-sign-requests) +- [Create Box Sign request](#create-box-sign-request) -## Cancel sign request +## Cancel Box Sign request Cancels a sign request. @@ -24,7 +24,7 @@ await client.SignRequests.CancelSignRequestAsync(signRequestId: NullableUtils.Un ### Arguments - signRequestId `string` - - The ID of the sign request Example: "33243242" + - The ID of the signature request Example: "33243242" - headers `CancelSignRequestHeaders` - Headers of cancelSignRequest method - cancellationToken `System.Threading.CancellationToken?` @@ -38,9 +38,9 @@ This function returns a value of type `SignRequest`. Returns a Sign Request object. -## Resend sign request +## Resend Box Sign request -Resends a sign request email to all outstanding signers. +Resends a signature request email to all outstanding signers. This operation is performed by calling function `ResendSignRequest`. @@ -52,7 +52,7 @@ See the endpoint docs at ### Arguments - signRequestId `string` - - The ID of the sign request Example: "33243242" + - The ID of the signature request Example: "33243242" - headers `ResendSignRequestHeaders` - Headers of resendSignRequest method - cancellationToken `System.Threading.CancellationToken?` @@ -67,7 +67,7 @@ Returns an empty response when the API call was successful. The email notifications will be sent asynchronously. -## Get sign request by ID +## Get Box Sign request by ID Gets a sign request by ID. @@ -84,7 +84,7 @@ await client.SignRequests.GetSignRequestByIdAsync(signRequestId: NullableUtils.U ### Arguments - signRequestId `string` - - The ID of the sign request Example: "33243242" + - The ID of the signature request Example: "33243242" - headers `GetSignRequestByIdHeaders` - Headers of getSignRequestById method - cancellationToken `System.Threading.CancellationToken?` @@ -95,13 +95,13 @@ await client.SignRequests.GetSignRequestByIdAsync(signRequestId: NullableUtils.U This function returns a value of type `SignRequest`. -Returns a sign request +Returns a signature request. -## List sign requests +## List Box Sign requests -Gets sign requests created by a user. If the `sign_files` and/or -`parent_folder` are deleted, the sign request will not return in the list. +Gets signature requests created by a user. If the `sign_files` and/or +`parent_folder` are deleted, the signature request will not return in the list. This operation is performed by calling function `GetSignRequests`. @@ -130,10 +130,10 @@ This function returns a value of type `SignRequests`. Returns a collection of sign requests -## Create sign request +## Create Box Sign request -Creates a sign request. This involves preparing a document for signing and -sending the sign request to signers. +Creates a signature request. This involves preparing a document for signing and +sending the signature request to signers. This operation is performed by calling function `CreateSignRequest`. @@ -159,6 +159,6 @@ await client.SignRequests.CreateSignRequestAsync(requestBody: new SignRequestCre This function returns a value of type `SignRequest`. -Returns a Sign Request object. +Returns a Box Sign request object.