Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: improve wording for box sign #424

Merged
merged 2 commits into from
May 15, 2024
Merged

fix: improve wording for box sign #424

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c58aa2
fix: improve wording for box sign
box-apimgmt May 15, 2024
3af6573
Fix linter issues
bszwarc May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 52 additions & 52 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2.0.0",
"x-box-commit-hash": "3cc3020078"
"x-box-commit-hash": "7081a9d4d3"
},
"servers": [
{
Expand Down Expand Up @@ -22904,7 +22904,7 @@
"/sign_requests/{sign_request_id}/cancel": {
"post": {
"operationId": "post_sign_requests_id_cancel",
"summary": "Cancel sign request",
"summary": "Cancel Box Sign request",
"tags": [
"Sign requests"
],
Expand All @@ -22913,7 +22913,7 @@
"parameters": [
{
"name": "sign_request_id",
"description": "The ID of the sign request",
"description": "The ID of the signature request",
"example": "33243242",
"in": "path",
"required": true,
Expand Down Expand Up @@ -22959,16 +22959,16 @@
"/sign_requests/{sign_request_id}/resend": {
"post": {
"operationId": "post_sign_requests_id_resend",
"summary": "Resend sign request",
"summary": "Resend Box Sign request",
"tags": [
"Sign requests"
],
"x-box-tag": "sign_requests",
"description": "Resends a sign request email to all outstanding signers.",
"description": "Resends a signature request email to all outstanding signers.",
"parameters": [
{
"name": "sign_request_id",
"description": "The ID of the sign request",
"description": "The ID of the signature request",
"example": "33243242",
"in": "path",
"required": true,
Expand All @@ -22982,7 +22982,7 @@
"description": "Returns an empty response when the API call was successful.\nThe email notifications will be sent asynchronously."
},
"404": {
"description": "Returns an error when the sign request cannot be found or the user does\nnot have access to the sign request.",
"description": "Returns an error when the signature request cannot be found or the user does\nnot have access to the signature request.",
"content": {
"application/json": {
"schema": {
Expand All @@ -23007,7 +23007,7 @@
"/sign_requests/{sign_request_id}": {
"get": {
"operationId": "get_sign_requests_id",
"summary": "Get sign request by ID",
"summary": "Get Box Sign request by ID",
"tags": [
"Sign requests"
],
Expand All @@ -23016,7 +23016,7 @@
"parameters": [
{
"name": "sign_request_id",
"description": "The ID of the sign request",
"description": "The ID of the signature request",
"example": "33243242",
"in": "path",
"required": true,
Expand All @@ -23027,7 +23027,7 @@
],
"responses": {
"200": {
"description": "Returns a sign request",
"description": "Returns a signature request.",
"content": {
"application/json": {
"schema": {
Expand All @@ -23037,7 +23037,7 @@
}
},
"404": {
"description": "Returns an error when the sign request cannot be found, the user does\nnot have access to the sign request, or `sign_files` and/or\n`parent_folder` is deleted.",
"description": "Returns an error when the signature request cannot be found, the user does\nnot have access to the signature request, or `sign_files` and/or\n`parent_folder` is deleted.",
"content": {
"application/json": {
"schema": {
Expand All @@ -23062,12 +23062,12 @@
"/sign_requests": {
"get": {
"operationId": "get_sign_requests",
"summary": "List sign requests",
"summary": "List Box Sign requests",
"tags": [
"Sign requests"
],
"x-box-tag": "sign_requests",
"description": "Gets sign requests created by a user. If the `sign_files` and/or\n`parent_folder` are deleted, the sign request will not return in the list.",
"description": "Gets signature requests created by a user. If the `sign_files` and/or\n`parent_folder` are deleted, the signature request will not return in the list.",
"parameters": [
{
"name": "marker",
Expand Down Expand Up @@ -23117,12 +23117,12 @@
},
"post": {
"operationId": "post_sign_requests",
"summary": "Create sign request",
"summary": "Create Box Sign request",
"tags": [
"Sign requests"
],
"x-box-tag": "sign_requests",
"description": "Creates a sign request. This involves preparing a document for signing and\nsending the sign request to signers.",
"description": "Creates a signature request. This involves preparing a document for signing and\nsending the signature request to signers.",
"requestBody": {
"content": {
"application/json": {
Expand All @@ -23134,7 +23134,7 @@
},
"responses": {
"201": {
"description": "Returns a Sign Request object.",
"description": "Returns a Box Sign request object.",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -24541,9 +24541,9 @@
]
},
"SignRequestCreateRequest": {
"title": "Create a sign request",
"title": "Create a Box Sign request",
"type": "object",
"description": "A request to create a sign request object",
"description": "Creates a Box Sign request object.",
"required": [
"signers"
],
Expand Down Expand Up @@ -24578,7 +24578,7 @@
"items": {
"$ref": "#/components/schemas/SignRequestCreateSigner"
},
"description": "Array of signers for the sign request. 35 is the max number of signers permitted."
"description": "Array of signers for the signature request. 35 is the max number of signers permitted."
},
"parent_folder": {
"allOf": [
Expand Down Expand Up @@ -33368,7 +33368,7 @@
},
"signer_group_id": {
"type": "string",
"description": "If provided, this value points signers that are assigned the same inputs and belongs to same signer group.\nA signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used\nwithin Sign Requests created from it.",
"description": "If provided, this value points signers that are assigned the same inputs and belongs to same signer group.\nA signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used\nwithin Box Sign requests created from it.",
"example": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
"nullable": true
}
Expand Down Expand Up @@ -36656,7 +36656,7 @@
}
},
"SignRequest--Base": {
"title": "Sign Request (Base)",
"title": "Box Sign request (Base)",
"type": "object",
"x-box-resource-id": "sign_request--base",
"x-box-tag": "sign_requests",
Expand All @@ -36665,17 +36665,17 @@
"base"
],
"x-box-variant": "base",
"description": "A request to create a sign request object",
"description": "A standard representation of a signature request object.",
"properties": {
"is_document_preparation_needed": {
"type": "boolean",
"description": "Indicates if the sender should receive a `prepare_url` in the response to complete document preparation via UI.",
"description": "Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI.",
"example": true
},
"redirect_url": {
"type": "string",
"example": "https://www.example.com",
"description": "When specified, signature request will be redirected to this url when a document is signed.",
"description": "When specified, the signature request will be redirected to this url when a document is signed.",
"nullable": true
},
"declined_redirect_url": {
Expand Down Expand Up @@ -36710,14 +36710,14 @@
"name": {
"type": "string",
"example": "name",
"description": "Name of the sign request."
"description": "Name of the signature request."
},
"prefill_tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignRequestPrefillTag"
},
"description": "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."
"description": "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."
},
"days_valid": {
"type": "integer",
Expand Down Expand Up @@ -36748,7 +36748,7 @@
}
},
"SignRequest": {
"title": "Sign Request",
"title": "Box Sign request",
"type": "object",
"x-box-resource-id": "sign_request",
"x-box-tag": "sign_requests",
Expand All @@ -36757,7 +36757,7 @@
"base"
],
"x-box-variant": "standard",
"description": "A Sign Request Object",
"description": "A Box Sign request object.",
"allOf": [
{
"$ref": "#/components/schemas/SignRequest--Base"
Expand All @@ -36784,7 +36784,7 @@
"items": {
"$ref": "#/components/schemas/SignRequestSigner"
},
"description": "Array of signers for the sign request"
"description": "Array of signers for the signature request."
},
"signature_color": {
"type": "string",
Expand All @@ -36795,12 +36795,12 @@
"id": {
"type": "string",
"example": "12345",
"description": "Sign request ID"
"description": "Box Sign request ID."
},
"prepare_url": {
"type": "string",
"example": "https://prepareurl.com",
"description": "This URL is returned if `is_document_preparation_needed` is\nset to `true` in the request. It is used to prepare the sign request\nvia UI. The sign request is not sent until preparation is complete.",
"description": "This URL is returned if `is_document_preparation_needed` is\nset to `true` for Box Sign request. It is used to prepare a signature request\nusing the UI. The signature request is not sent until the preparation\nphase is complete.",
"nullable": true
},
"signing_log": {
Expand All @@ -36809,7 +36809,7 @@
"$ref": "#/components/schemas/File--Mini"
},
{
"description": "Reference to a file that holds a log of all signer activity for\nthe request"
"description": "Reference to a file that holds a log of all signer activity for\nthe request."
}
]
},
Expand All @@ -36830,7 +36830,7 @@
"error_finalizing"
],
"example": "converting",
"description": "Describes the status of the sign request"
"description": "Describes the status of the signature request."
},
"sign_files": {
"type": "object",
Expand Down Expand Up @@ -36872,11 +36872,11 @@
]
},
"SignRequests": {
"title": "Box Sign",
"title": "Box Sign requests",
"type": "object",
"x-box-resource-id": "sign_requests",
"x-box-tag": "sign_requests",
"description": "A standard representation of a sign request, as returned from any Box Sign\nAPI endpoints by default.",
"description": "A standard representation of a signature request, as returned from any Box Sign\nAPI endpoints by default.",
"allOf": [
{
"type": "object",
Expand All @@ -36900,7 +36900,7 @@
"properties": {
"entries": {
"type": "array",
"description": "A list of sign requests",
"description": "A list of Box Sign requests.",
"items": {
"$ref": "#/components/schemas/SignRequest"
}
Expand Down Expand Up @@ -37846,9 +37846,9 @@
}
},
"SignRequestCreateSigner": {
"title": "Signer fields for Create Sign Request",
"title": "Signer fields used to create a Box Sign request object.",
"type": "object",
"description": "The schema for a Signer in a POST Sign Request request body",
"description": "The schema for a Signer object used in\nfor creating a Box Sign request object.",
"properties": {
"email": {
"type": "string",
Expand All @@ -37863,7 +37863,7 @@
"approver",
"final_copy_reader"
],
"description": "Defines the role of the signer in the sign request. A `signer`\nmust sign the document and an `approver` must approve the document. A\n`final_copy_reader` only receives the final signed document and signing\nlog.",
"description": "Defines the role of the signer in the signature request. A `signer`\nmust sign the document and an `approver` must approve the document. A\n`final_copy_reader` only receives the final signed document and signing\nlog.",
"example": "signer",
"default": "signer"
},
Expand Down Expand Up @@ -37924,14 +37924,14 @@
}
},
"SignRequestPrefillTag": {
"title": "Sign Request Prefill Tag",
"title": "Sign request prefill tag",
"type": "object",
"description": "Prefill tags are used to prefill placeholders with signer input data. Only\none value field can be included.",
"properties": {
"document_tag_id": {
"type": "string",
"example": "1234",
"description": "This references the ID of a specific tag contained in a file of the sign request.",
"description": "This references the ID of a specific tag contained in a file of the signature request.",
"nullable": true
},
"text_value": {
Expand Down Expand Up @@ -38018,9 +38018,9 @@
]
},
"SignRequestSigner": {
"title": "Signer fields for GET Sign Request response",
"title": "Signer fields for Box Sign request response",
"type": "object",
"description": "The schema for a Signer in a GET Sign Request request body",
"description": "The schema for a Signer object used\non the body of a Box Sign request object.",
"required": [
"email"
],
Expand All @@ -38046,22 +38046,22 @@
"declined"
],
"example": "signed",
"description": "Type of decision made by the signer"
"description": "Type of decision made by the signer."
},
"finalized_at": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T08:12:13.982Z",
"description": "Date and Time that the decision was made"
"description": "Date and Time that the decision was made."
},
"additional_info": {
"type": "string",
"example": "Requesting changes before signing.",
"description": "Additional info about the decision, such as the decline reason from the signer",
"description": "Additional info about the decision, such as the decline reason from the signer.",
"nullable": true
}
},
"description": "Final decision made by the signer",
"description": "Final decision made by the signer.",
"nullable": true
},
"inputs": {
Expand All @@ -38082,7 +38082,7 @@
"type": "string",
"nullable": true,
"example": "https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4",
"description": "This URL is specifically designed for\nsigning documents within an HTML `iframe` tag.\nIt will be returned in the response\nonly if the `embed_url_external_user_id`\nparameter was passed in the\n`create sign request` call."
"description": "This URL is specifically designed for\nsigning documents within an HTML `iframe` tag.\nIt will be returned in the response\nonly if the `embed_url_external_user_id`\nparameter was passed in the\n`create Box Sign request` call."
}
}
}
Expand Down Expand Up @@ -38271,8 +38271,8 @@
"x-box-priority": true
},
{
"name": "Sign requests",
"description": "Sign requests are used\nto submit a file for\nsignature.",
"name": "Box Sign requests",
"description": "Box Sign requests are used\nto submit a file for\nsignature.",
"x-box-tag": "sign_requests"
},
{
Expand Down Expand Up @@ -38491,8 +38491,8 @@
"x-box-tag": "shield_information_barrier_segment_restrictions"
},
{
"name": "Sign templates",
"description": "Sign templates allow you to use a predefined Box Sign\ntemplate when creating a sign request.\nThe template includes placeholders that\nare automatically populated with data when creating the request.",
"name": "Box Sign templates",
"description": "Sign templates allow you to use a predefined Box Sign\ntemplate when creating a signature request.\nThe template includes placeholders that\nare automatically populated with data when creating the request.",
"x-box-tag": "sign_templates"
},
{
Expand Down
Loading