diff --git a/openapi-fern.yaml b/openapi-fern.yaml
index 7f68a6004..aa4d43aab 100644
--- a/openapi-fern.yaml
+++ b/openapi-fern.yaml
@@ -23913,8 +23913,8 @@ components:
Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ maxProperties: 10
type: object
- maxItems: 10
additionalProperties: {}
signing_redirect_url:
description: The URL you want signers redirected to after they successfully sign.
@@ -24006,8 +24006,8 @@ components:
Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ maxProperties: 10
type: object
- maxItems: 10
additionalProperties: {}
signing_redirect_url:
description: The URL you want signers redirected to after they successfully sign.
@@ -25085,6 +25085,14 @@ components:
type: array
items:
$ref: '#/components/schemas/SubSignatureRequestTemplateSigner'
+ metadata:
+ description: |-
+ Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
+
+ Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ maxProperties: 10
+ type: object
+ additionalProperties: {}
type: object
SubBulkSignerListCustomField:
required:
@@ -26091,6 +26099,10 @@ components:
description: The name of your Team.
type: string
default: Untitled Team
+ parent_team_id:
+ description: The id of the parent team. Set this to create the new team as a sub-team of that parent.
+ type: string
+ example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
type: object
TeamRemoveMemberRequest:
properties:
@@ -28272,6 +28284,12 @@ components:
TeamResponse:
description: Contains information about your team and its members
properties:
+ team_id:
+ description: The id of a team
+ type: string
+ parent_team_id:
+ description: The id of this team's parent team.
+ type: string
name:
description: The name of your Team
type: string
@@ -30201,6 +30219,16 @@ components:
default: Hello API Event Received
x-fern-audiences:
- events
+ parameters:
+ IdempotencyKey:
+ name: Idempotency-Key
+ in: header
+ description: Optional header on an authenticated POST or PUT. Reuse the same key when retrying the same request. See [Idempotency](/api/manual-reference-pages/idempotency) for details.
+ required: false
+ schema:
+ type: string
+ maxLength: 255
+ minLength: 1
examples:
AccountCreateRequest:
summary: Default Example
@@ -35116,6 +35144,11 @@ components:
type: integer
format: int64
example: 1430170900
+ Idempotent-Replayed:
+ description: Sent when the request included an Idempotency-Key. True when replaying a stored response, false otherwise. See [Idempotency](/api/manual-reference-pages/idempotency) for details.
+ required: false
+ schema:
+ type: boolean
securitySchemes:
api_key:
type: http
@@ -35349,8 +35382,8 @@ x-error-codes:
conflict:
http_status: 409
summary: The request was well-formed but conflicts with the current state.
- cause: The target resource is in a state incompatible with the request (e.g. a signature request is still being set up).
- remediation: 'Wait briefly and retry, or listen for a callback event confirming the resource is ready.'
+ cause: The target resource is in a state incompatible with the request (e.g. a signature request is still being set up). A POST or PUT can also return this status when an Idempotency-Key header is reused with different parameters, or while the original request is still in progress.
+ remediation: 'Wait briefly and retry, or listen for a callback event confirming the resource is ready. To make a POST or PUT safe to retry, send the same Idempotency-Key header (1 to 255 characters) with the other headers for that request. The same key and request within 24 hours returns the original response, with Idempotent-Replayed: true. Use a new key for a different request.'
retryable: conditional
exceeded_rate:
http_status: 429
diff --git a/openapi-raw.yaml b/openapi-raw.yaml
index 7295d2c6e..3a409b1e3 100644
--- a/openapi-raw.yaml
+++ b/openapi-raw.yaml
@@ -13,6 +13,118 @@ servers:
-
url: 'https://api.hellosign.com/v3'
paths:
+ '/account/api_key/{account_id}':
+ post:
+ tags:
+ - Account
+ summary: '_t__AccountApiKeyCreate::SUMMARY'
+ description: '_t__AccountApiKeyCreate::DESCRIPTION'
+ operationId: accountApiKeyCreate
+ parameters:
+ -
+ name: account_id
+ in: path
+ description: '_t__AccountApiKeyCreate::ACCOUNT_ID'
+ required: true
+ schema:
+ type: string
+ example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AccountApiKeyCreateRequest'
+ examples:
+ example:
+ $ref: '#/components/examples/AccountApiKeyCreateRequest'
+ responses:
+ '201':
+ description: 'successful operation'
+ headers:
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-Ratelimit-Reset:
+ $ref: '#/components/headers/X-Ratelimit-Reset'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AccountApiKeyCreateResponse'
+ examples:
+ example:
+ $ref: '#/components/examples/AccountApiKeyCreateResponse'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400Response'
+ 401_example:
+ $ref: '#/components/examples/Error401Response'
+ 402_example:
+ $ref: '#/components/examples/Error402Response'
+ 403_example:
+ $ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
+ 404_example:
+ $ref: '#/components/examples/Error404Response'
+ 409_example:
+ $ref: '#/components/examples/Error409Response'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponse'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/AccountApiKeyCreateExample.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/AccountApiKeyCreateExample.cs
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/AccountApiKeyCreateExample.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/AccountApiKeyCreateExample.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/AccountApiKeyCreateExample.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/AccountApiKeyCreateExample.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/AccountApiKeyCreateExample.sh
+ x-meta:
+ seo:
+ title: '_t__AccountApiKeyCreate::SEO::TITLE'
+ description: '_t__AccountApiKeyCreate::SEO::DESCRIPTION'
+ x-hideOn:
+ - sdk
+ - doc
+ x-beta: closed
/account/create:
post:
tags:
@@ -7985,6 +8097,18 @@ paths:
description: '_t__UnclaimedDraftEditAndResend::SEO::DESCRIPTION'
components:
schemas:
+ AccountApiKeyCreateRequest:
+ required:
+ - name
+ properties:
+ name:
+ description: '_t__AccountApiKeyCreate::NAME'
+ type: string
+ maxLength: 25
+ type: object
+ x-hideOn:
+ - sdk
+ - doc
AccountCreateRequest:
required:
- email_address
@@ -8463,9 +8587,9 @@ components:
type: string
maxLength: 5000
metadata:
- description: '_t__Sub::Metadata::DESCRIPTION'
+ description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::METADATA'
+ maxProperties: 10
type: object
- maxItems: 10
additionalProperties: { }
signing_redirect_url:
description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNING_REDIRECT_URL'
@@ -8527,9 +8651,9 @@ components:
type: string
maxLength: 5000
metadata:
- description: '_t__Sub::Metadata::DESCRIPTION'
+ description: '_t__SignatureRequestBulkSendWithTemplate::METADATA'
+ maxProperties: 10
type: object
- maxItems: 10
additionalProperties: { }
signing_redirect_url:
description: '_t__SignatureRequestBulkSendWithTemplate::SIGNING_REDIRECT_URL'
@@ -9445,6 +9569,11 @@ components:
type: array
items:
$ref: '#/components/schemas/SubSignatureRequestTemplateSigner'
+ metadata:
+ description: '_t__Sub::BulkSigner::METADATA'
+ maxProperties: 10
+ type: object
+ additionalProperties: { }
type: object
SubBulkSignerListCustomField:
required:
@@ -10350,6 +10479,10 @@ components:
description: '_t__TeamCreate::NAME'
type: string
default: 'Untitled Team'
+ parent_team_id:
+ description: '_t__TeamCreate::PARENT_TEAM_ID'
+ type: string
+ example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
type: object
TeamRemoveMemberRequest:
properties:
@@ -11128,6 +11261,22 @@ components:
type: boolean
default: false
type: object
+ AccountApiKeyCreateResponse:
+ required:
+ - api_key
+ properties:
+ api_key:
+ $ref: '#/components/schemas/AccountApiKeyResponse'
+ warnings:
+ description: '_t__WarningResponse::LIST_DESCRIPTION'
+ type: array
+ items:
+ $ref: '#/components/schemas/WarningResponse'
+ type: object
+ x-internal-class: true
+ x-hideOn:
+ - sdk
+ - doc
AccountCreateResponse:
required:
- account
@@ -11468,6 +11617,49 @@ components:
$ref: '#/components/schemas/AccountResponseSettings'
type: object
x-internal-class: true
+ AccountApiKeyResponse:
+ required:
+ - api_key_id
+ - account_id
+ - name
+ - secret
+ - is_primary
+ - created_at
+ - updated_at
+ properties:
+ api_key_id:
+ description: '_t__AccountApiKey::API_KEY_ID'
+ type: string
+ account_id:
+ description: '_t__AccountApiKey::ACCOUNT_ID'
+ type: string
+ name:
+ description: '_t__AccountApiKey::NAME'
+ type: string
+ secret:
+ description: '_t__AccountApiKeyCreate::SECRET'
+ type: string
+ maxLength: 64
+ minLength: 64
+ readOnly: true
+ is_primary:
+ description: '_t__AccountApiKey::IS_PRIMARY'
+ type: boolean
+ last_used_at:
+ description: '_t__AccountApiKey::LAST_USED_AT'
+ type: integer
+ nullable: true
+ created_at:
+ description: '_t__AccountApiKey::CREATED_AT'
+ type: integer
+ updated_at:
+ description: '_t__AccountApiKey::UPDATED_AT'
+ type: integer
+ type: object
+ x-internal-class: true
+ x-hideOn:
+ - sdk
+ - doc
OAuthTokenResponse:
properties:
access_token:
@@ -12424,6 +12616,12 @@ components:
TeamResponse:
description: '_t__TeamResponse::DESCRIPTION'
properties:
+ team_id:
+ description: '_t__TeamGeneral::TEAM_ID'
+ type: string
+ parent_team_id:
+ description: '_t__Team::PARENT_TEAM_ID'
+ type: string
name:
description: '_t__Team::NAME'
type: string
@@ -14234,7 +14432,25 @@ components:
default: 'Hello API Event Received'
x-fern-audiences:
- events
+ parameters:
+ IdempotencyKey:
+ name: Idempotency-Key
+ in: header
+ description: '_t__Common::Idempotency::KEY'
+ required: false
+ schema:
+ type: string
+ maxLength: 255
+ minLength: 1
+ x-hideOn: sdk
examples:
+ AccountApiKeyCreateRequest:
+ summary: 'Default Example'
+ value:
+ $ref: examples/json/AccountApiKeyCreateRequest.json
+ x-hideOn:
+ - sdk
+ - doc
AccountCreateRequest:
summary: 'Default Example'
value:
@@ -14474,6 +14690,13 @@ components:
summary: 'Default Example'
value:
$ref: examples/json/UnclaimedDraftEditAndResendRequest.json
+ AccountApiKeyCreateResponse:
+ summary: 'Default Example'
+ value:
+ $ref: examples/json/AccountApiKeyCreateResponse.json
+ x-hideOn:
+ - sdk
+ - doc
AccountCreateResponse:
summary: '_t__AccountCreateResponseExample::SUMMARY'
value:
@@ -14992,6 +15215,12 @@ components:
type: integer
format: int64
example: 1430170900
+ Idempotent-Replayed:
+ description: '_t__Common::Idempotency::REPLAYED'
+ required: false
+ schema:
+ type: boolean
+ x-hideOn: sdk
securitySchemes:
api_key:
type: http
diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml
index a05971e9f..788b938ac 100644
--- a/openapi-sdk.yaml
+++ b/openapi-sdk.yaml
@@ -8441,8 +8441,8 @@ components:
Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ maxProperties: 10
type: object
- maxItems: 10
additionalProperties: {}
signing_redirect_url:
description: 'The URL you want signers redirected to after they successfully sign.'
@@ -8534,8 +8534,8 @@ components:
Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ maxProperties: 10
type: object
- maxItems: 10
additionalProperties: {}
signing_redirect_url:
description: 'The URL you want signers redirected to after they successfully sign.'
@@ -9633,6 +9633,14 @@ components:
type: array
items:
$ref: '#/components/schemas/SubSignatureRequestTemplateSigner'
+ metadata:
+ description: |-
+ Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
+
+ Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ maxProperties: 10
+ type: object
+ additionalProperties: {}
type: object
SubBulkSignerListCustomField:
required:
@@ -10649,6 +10657,10 @@ components:
description: 'The name of your Team.'
type: string
default: 'Untitled Team'
+ parent_team_id:
+ description: 'The id of the parent team. Set this to create the new team as a sub-team of that parent.'
+ type: string
+ example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
type: object
TeamRemoveMemberRequest:
properties:
@@ -12838,6 +12850,12 @@ components:
TeamResponse:
description: 'Contains information about your team and its members'
properties:
+ team_id:
+ description: 'The id of a team'
+ type: string
+ parent_team_id:
+ description: 'The id of this team''s parent team.'
+ type: string
name:
description: 'The name of your Team'
type: string
@@ -14940,8 +14958,8 @@ x-error-codes:
conflict:
http_status: 409
summary: 'The request was well-formed but conflicts with the current state.'
- cause: 'The target resource is in a state incompatible with the request (e.g. a signature request is still being set up).'
- remediation: 'Wait briefly and retry, or listen for a callback event confirming the resource is ready.'
+ cause: 'The target resource is in a state incompatible with the request (e.g. a signature request is still being set up). A POST or PUT can also return this status when an Idempotency-Key header is reused with different parameters, or while the original request is still in progress.'
+ remediation: 'Wait briefly and retry, or listen for a callback event confirming the resource is ready. To make a POST or PUT safe to retry, send the same Idempotency-Key header (1 to 255 characters) with the other headers for that request. The same key and request within 24 hours returns the original response, with Idempotent-Replayed: true. Use a new key for a different request.'
retryable: conditional
exceeded_rate:
http_status: 429
diff --git a/openapi.yaml b/openapi.yaml
index 6be19e5a2..f7f764ebf 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -8441,8 +8441,8 @@ components:
Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ maxProperties: 10
type: object
- maxItems: 10
additionalProperties: {}
signing_redirect_url:
description: 'The URL you want signers redirected to after they successfully sign.'
@@ -8534,8 +8534,8 @@ components:
Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ maxProperties: 10
type: object
- maxItems: 10
additionalProperties: {}
signing_redirect_url:
description: 'The URL you want signers redirected to after they successfully sign.'
@@ -9613,6 +9613,14 @@ components:
type: array
items:
$ref: '#/components/schemas/SubSignatureRequestTemplateSigner'
+ metadata:
+ description: |-
+ Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
+
+ Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ maxProperties: 10
+ type: object
+ additionalProperties: {}
type: object
SubBulkSignerListCustomField:
required:
@@ -10629,6 +10637,10 @@ components:
description: 'The name of your Team.'
type: string
default: 'Untitled Team'
+ parent_team_id:
+ description: 'The id of the parent team. Set this to create the new team as a sub-team of that parent.'
+ type: string
+ example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
type: object
TeamRemoveMemberRequest:
properties:
@@ -12824,6 +12836,12 @@ components:
TeamResponse:
description: 'Contains information about your team and its members'
properties:
+ team_id:
+ description: 'The id of a team'
+ type: string
+ parent_team_id:
+ description: 'The id of this team''s parent team.'
+ type: string
name:
description: 'The name of your Team'
type: string
@@ -14771,6 +14789,16 @@ components:
default: 'Hello API Event Received'
x-fern-audiences:
- events
+ parameters:
+ IdempotencyKey:
+ name: Idempotency-Key
+ in: header
+ description: 'Optional header on an authenticated POST or PUT. Reuse the same key when retrying the same request. See [Idempotency](/api/manual-reference-pages/idempotency) for details.'
+ required: false
+ schema:
+ type: string
+ maxLength: 255
+ minLength: 1
examples:
AccountCreateRequest:
summary: 'Default Example'
@@ -15526,6 +15554,11 @@ components:
type: integer
format: int64
example: 1430170900
+ Idempotent-Replayed:
+ description: 'Sent when the request included an Idempotency-Key. True when replaying a stored response, false otherwise. See [Idempotency](/api/manual-reference-pages/idempotency) for details.'
+ required: false
+ schema:
+ type: boolean
securitySchemes:
api_key:
type: http
@@ -15811,8 +15844,8 @@ x-error-codes:
conflict:
http_status: 409
summary: 'The request was well-formed but conflicts with the current state.'
- cause: 'The target resource is in a state incompatible with the request (e.g. a signature request is still being set up).'
- remediation: 'Wait briefly and retry, or listen for a callback event confirming the resource is ready.'
+ cause: 'The target resource is in a state incompatible with the request (e.g. a signature request is still being set up). A POST or PUT can also return this status when an Idempotency-Key header is reused with different parameters, or while the original request is still in progress.'
+ remediation: 'Wait briefly and retry, or listen for a callback event confirming the resource is ready. To make a POST or PUT safe to retry, send the same Idempotency-Key header (1 to 255 characters) with the other headers for that request. The same key and request within 24 hours returns the original response, with Idempotent-Replayed: true. Use a new key for a different request.'
retryable: conditional
exceeded_rate:
http_status: 429
diff --git a/sdks/dotnet/docs/SubBulkSignerList.md b/sdks/dotnet/docs/SubBulkSignerList.md
index c256792ff..56ac295ac 100644
--- a/sdks/dotnet/docs/SubBulkSignerList.md
+++ b/sdks/dotnet/docs/SubBulkSignerList.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**CustomFields** | [**List<SubBulkSignerListCustomField>**](SubBulkSignerListCustomField.md) | An array of custom field values. | [optional] **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
Currently only templates with a single role are supported. All signers must have the same `role` value. | [optional]
+**CustomFields** | [**List<SubBulkSignerListCustomField>**](SubBulkSignerListCustomField.md) | An array of custom field values. | [optional] **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
Currently only templates with a single role are supported. All signers must have the same `role` value. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/sdks/dotnet/docs/TeamCreateRequest.md b/sdks/dotnet/docs/TeamCreateRequest.md
index e3727b07c..887d9e8b2 100644
--- a/sdks/dotnet/docs/TeamCreateRequest.md
+++ b/sdks/dotnet/docs/TeamCreateRequest.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**Name** | **string** | The name of your Team. | [optional] [default to "Untitled Team"]
+**Name** | **string** | The name of your Team. | [optional] [default to "Untitled Team"]**ParentTeamId** | **string** | The id of the parent team. Set this to create the new team as a sub-team of that parent. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/sdks/dotnet/docs/TeamResponse.md b/sdks/dotnet/docs/TeamResponse.md
index 977696c0a..3f2e9f54f 100644
--- a/sdks/dotnet/docs/TeamResponse.md
+++ b/sdks/dotnet/docs/TeamResponse.md
@@ -5,7 +5,7 @@ Contains information about your team and its members
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**Name** | **string** | The name of your Team | [optional] **Accounts** | [**List<AccountResponse>**](AccountResponse.md) | | [optional] **InvitedAccounts** | [**List<AccountResponse>**](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | [optional] **InvitedEmails** | **List<string>** | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | [optional]
+**TeamId** | **string** | The id of a team | [optional] **ParentTeamId** | **string** | The id of this team's parent team. | [optional] **Name** | **string** | The name of your Team | [optional] **Accounts** | [**List<AccountResponse>**](AccountResponse.md) | | [optional] **InvitedAccounts** | [**List<AccountResponse>**](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | [optional] **InvitedEmails** | **List<string>** | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubBulkSignerList.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubBulkSignerList.cs
index 3651de670..298c7c0e5 100644
--- a/sdks/dotnet/src/Dropbox.Sign/Model/SubBulkSignerList.cs
+++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubBulkSignerList.cs
@@ -43,11 +43,13 @@ protected SubBulkSignerList() { }
///
/// An array of custom field values..
/// Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. Currently only templates with a single role are supported. All signers must have the same `role` value..
- public SubBulkSignerList(List customFields = default(List), List signers = default(List))
+ /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long..
+ public SubBulkSignerList(List customFields = default(List), List signers = default(List), Dictionary metadata = default(Dictionary))
{
this.CustomFields = customFields;
this.Signers = signers;
+ this.Metadata = metadata;
}
///
@@ -80,6 +82,13 @@ public static SubBulkSignerList Init(string jsonData)
[DataMember(Name = "signers", EmitDefaultValue = true)]
public List Signers { get; set; }
+ ///
+ /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ ///
+ /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ [DataMember(Name = "metadata", EmitDefaultValue = true)]
+ public Dictionary Metadata { get; set; }
+
///
/// Returns the string presentation of the object
///
@@ -90,6 +99,7 @@ public override string ToString()
sb.Append("class SubBulkSignerList {\n");
sb.Append(" CustomFields: ").Append(CustomFields).Append("\n");
sb.Append(" Signers: ").Append(Signers).Append("\n");
+ sb.Append(" Metadata: ").Append(Metadata).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
@@ -136,6 +146,12 @@ public bool Equals(SubBulkSignerList input)
this.Signers != null &&
input.Signers != null &&
this.Signers.SequenceEqual(input.Signers)
+ ) &&
+ (
+ this.Metadata == input.Metadata ||
+ this.Metadata != null &&
+ input.Metadata != null &&
+ this.Metadata.SequenceEqual(input.Metadata)
);
}
@@ -156,6 +172,10 @@ public override int GetHashCode()
{
hashCode = (hashCode * 59) + this.Signers.GetHashCode();
}
+ if (this.Metadata != null)
+ {
+ hashCode = (hashCode * 59) + this.Metadata.GetHashCode();
+ }
return hashCode;
}
}
@@ -186,6 +206,13 @@ public List GetOpenApiTypes()
Type = "List",
Value = Signers,
});
+ types.Add(new OpenApiType()
+ {
+ Name = "metadata",
+ Property = "Metadata",
+ Type = "Dictionary",
+ Value = Metadata,
+ });
return types;
}
diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TeamCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TeamCreateRequest.cs
index 28d663851..63802443f 100644
--- a/sdks/dotnet/src/Dropbox.Sign/Model/TeamCreateRequest.cs
+++ b/sdks/dotnet/src/Dropbox.Sign/Model/TeamCreateRequest.cs
@@ -42,11 +42,13 @@ protected TeamCreateRequest() { }
/// Initializes a new instance of the class.
///
/// The name of your Team. (default to "Untitled Team").
- public TeamCreateRequest(string name = @"Untitled Team")
+ /// The id of the parent team. Set this to create the new team as a sub-team of that parent..
+ public TeamCreateRequest(string name = @"Untitled Team", string parentTeamId = default(string))
{
// use default value if no "name" provided
this.Name = name ?? "Untitled Team";
+ this.ParentTeamId = parentTeamId;
}
///
@@ -72,6 +74,14 @@ public static TeamCreateRequest Init(string jsonData)
[DataMember(Name = "name", EmitDefaultValue = true)]
public string Name { get; set; }
+ ///
+ /// The id of the parent team. Set this to create the new team as a sub-team of that parent.
+ ///
+ /// The id of the parent team. Set this to create the new team as a sub-team of that parent.
+ /// 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
+ [DataMember(Name = "parent_team_id", EmitDefaultValue = true)]
+ public string ParentTeamId { get; set; }
+
///
/// Returns the string presentation of the object
///
@@ -81,6 +91,7 @@ public override string ToString()
StringBuilder sb = new StringBuilder();
sb.Append("class TeamCreateRequest {\n");
sb.Append(" Name: ").Append(Name).Append("\n");
+ sb.Append(" ParentTeamId: ").Append(ParentTeamId).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
@@ -120,6 +131,11 @@ public bool Equals(TeamCreateRequest input)
this.Name == input.Name ||
(this.Name != null &&
this.Name.Equals(input.Name))
+ ) &&
+ (
+ this.ParentTeamId == input.ParentTeamId ||
+ (this.ParentTeamId != null &&
+ this.ParentTeamId.Equals(input.ParentTeamId))
);
}
@@ -136,6 +152,10 @@ public override int GetHashCode()
{
hashCode = (hashCode * 59) + this.Name.GetHashCode();
}
+ if (this.ParentTeamId != null)
+ {
+ hashCode = (hashCode * 59) + this.ParentTeamId.GetHashCode();
+ }
return hashCode;
}
}
@@ -159,6 +179,13 @@ public List GetOpenApiTypes()
Type = "string",
Value = Name,
});
+ types.Add(new OpenApiType()
+ {
+ Name = "parent_team_id",
+ Property = "ParentTeamId",
+ Type = "string",
+ Value = ParentTeamId,
+ });
return types;
}
diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs
index 56d78eb53..21a0dadd6 100644
--- a/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs
+++ b/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs
@@ -41,13 +41,17 @@ protected TeamResponse() { }
///
/// Initializes a new instance of the class.
///
+ /// The id of a team.
+ /// The id of this team's parent team..
/// The name of your Team.
/// accounts.
/// A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`..
/// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account..
- public TeamResponse(string name = default(string), List accounts = default(List), List invitedAccounts = default(List), List invitedEmails = default(List))
+ public TeamResponse(string teamId = default(string), string parentTeamId = default(string), string name = default(string), List accounts = default(List), List invitedAccounts = default(List), List invitedEmails = default(List))
{
+ this.TeamId = teamId;
+ this.ParentTeamId = parentTeamId;
this.Name = name;
this.Accounts = accounts;
this.InvitedAccounts = invitedAccounts;
@@ -70,6 +74,20 @@ public static TeamResponse Init(string jsonData)
return obj;
}
+ ///
+ /// The id of a team
+ ///
+ /// The id of a team
+ [DataMember(Name = "team_id", EmitDefaultValue = true)]
+ public string TeamId { get; set; }
+
+ ///
+ /// The id of this team's parent team.
+ ///
+ /// The id of this team's parent team.
+ [DataMember(Name = "parent_team_id", EmitDefaultValue = true)]
+ public string ParentTeamId { get; set; }
+
///
/// The name of your Team
///
@@ -105,6 +123,8 @@ public override string ToString()
{
StringBuilder sb = new StringBuilder();
sb.Append("class TeamResponse {\n");
+ sb.Append(" TeamId: ").Append(TeamId).Append("\n");
+ sb.Append(" ParentTeamId: ").Append(ParentTeamId).Append("\n");
sb.Append(" Name: ").Append(Name).Append("\n");
sb.Append(" Accounts: ").Append(Accounts).Append("\n");
sb.Append(" InvitedAccounts: ").Append(InvitedAccounts).Append("\n");
@@ -144,6 +164,16 @@ public bool Equals(TeamResponse input)
return false;
}
return
+ (
+ this.TeamId == input.TeamId ||
+ (this.TeamId != null &&
+ this.TeamId.Equals(input.TeamId))
+ ) &&
+ (
+ this.ParentTeamId == input.ParentTeamId ||
+ (this.ParentTeamId != null &&
+ this.ParentTeamId.Equals(input.ParentTeamId))
+ ) &&
(
this.Name == input.Name ||
(this.Name != null &&
@@ -178,6 +208,14 @@ public override int GetHashCode()
unchecked // Overflow is fine, just wrap
{
int hashCode = 41;
+ if (this.TeamId != null)
+ {
+ hashCode = (hashCode * 59) + this.TeamId.GetHashCode();
+ }
+ if (this.ParentTeamId != null)
+ {
+ hashCode = (hashCode * 59) + this.ParentTeamId.GetHashCode();
+ }
if (this.Name != null)
{
hashCode = (hashCode * 59) + this.Name.GetHashCode();
@@ -211,6 +249,20 @@ public List GetOpenApiTypes()
{
var types = new List();
types.Add(new OpenApiType()
+ {
+ Name = "team_id",
+ Property = "TeamId",
+ Type = "string",
+ Value = TeamId,
+ });
+ types.Add(new OpenApiType()
+ {
+ Name = "parent_team_id",
+ Property = "ParentTeamId",
+ Type = "string",
+ Value = ParentTeamId,
+ });
+ types.Add(new OpenApiType()
{
Name = "name",
Property = "Name",
diff --git a/sdks/java-v1/docs/SubBulkSignerList.md b/sdks/java-v1/docs/SubBulkSignerList.md
index 918c935b1..85b91dbf3 100644
--- a/sdks/java-v1/docs/SubBulkSignerList.md
+++ b/sdks/java-v1/docs/SubBulkSignerList.md
@@ -10,6 +10,7 @@
|------------ | ------------- | ------------- | -------------|
| `customFields` | [```List```](SubBulkSignerListCustomField.md) | An array of custom field values. | |
| `signers` | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
Currently only templates with a single role are supported. All signers must have the same `role` value. | |
+| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
diff --git a/sdks/java-v1/docs/TeamCreateRequest.md b/sdks/java-v1/docs/TeamCreateRequest.md
index 1a4861618..c66c6083e 100644
--- a/sdks/java-v1/docs/TeamCreateRequest.md
+++ b/sdks/java-v1/docs/TeamCreateRequest.md
@@ -9,6 +9,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| `name` | ```String``` | The name of your Team. | |
+| `parentTeamId` | ```String``` | The id of the parent team. Set this to create the new team as a sub-team of that parent. | |
diff --git a/sdks/java-v1/docs/TeamResponse.md b/sdks/java-v1/docs/TeamResponse.md
index ca6344cfc..3348936d3 100644
--- a/sdks/java-v1/docs/TeamResponse.md
+++ b/sdks/java-v1/docs/TeamResponse.md
@@ -8,6 +8,8 @@ Contains information about your team and its members
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
+| `teamId` | ```String``` | The id of a team | |
+| `parentTeamId` | ```String``` | The id of this team's parent team. | |
| `name` | ```String``` | The name of your Team | |
| `accounts` | [```List```](AccountResponse.md) | | |
| `invitedAccounts` | [```List```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | |
diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java
index d08a75d1e..21b68fe39 100644
--- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java
+++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java
@@ -28,7 +28,8 @@
/** SubBulkSignerList */
@JsonPropertyOrder({
SubBulkSignerList.JSON_PROPERTY_CUSTOM_FIELDS,
- SubBulkSignerList.JSON_PROPERTY_SIGNERS
+ SubBulkSignerList.JSON_PROPERTY_SIGNERS,
+ SubBulkSignerList.JSON_PROPERTY_METADATA
})
@javax.annotation.Generated(
value = "org.openapitools.codegen.languages.JavaClientCodegen",
@@ -41,6 +42,9 @@ public class SubBulkSignerList {
public static final String JSON_PROPERTY_SIGNERS = "signers";
@javax.annotation.Nullable private List signers = null;
+ public static final String JSON_PROPERTY_METADATA = "metadata";
+ @javax.annotation.Nullable private Map metadata = null;
+
public SubBulkSignerList() {}
/**
@@ -123,6 +127,40 @@ public void setSigners(
this.signers = signers;
}
+ public SubBulkSignerList metadata(@javax.annotation.Nullable Map metadata) {
+ this.metadata = metadata;
+ return this;
+ }
+
+ public SubBulkSignerList putMetadataItem(String key, Object metadataItem) {
+ if (this.metadata == null) {
+ this.metadata = new HashMap<>();
+ }
+ this.metadata.put(key, metadataItem);
+ return this;
+ }
+
+ /**
+ * Key-value data that should be attached to the signature request. This metadata is included in
+ * all API responses and events involving the signature request. For example, use the metadata
+ * field to store a signer's order number for look up when receiving events for the
+ * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata
+ * keys), with key names up to 40 characters long and values up to 1000 characters long.
+ *
+ * @return metadata
+ */
+ @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_METADATA)
+ @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)
+ public Map getMetadata() {
+ return metadata;
+ }
+
+ @JsonProperty(JSON_PROPERTY_METADATA)
+ @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)
+ public void setMetadata(@javax.annotation.Nullable Map metadata) {
+ this.metadata = metadata;
+ }
+
/** Return true if this SubBulkSignerList object is equal to o. */
@Override
public boolean equals(Object o) {
@@ -134,12 +172,13 @@ public boolean equals(Object o) {
}
SubBulkSignerList subBulkSignerList = (SubBulkSignerList) o;
return Objects.equals(this.customFields, subBulkSignerList.customFields)
- && Objects.equals(this.signers, subBulkSignerList.signers);
+ && Objects.equals(this.signers, subBulkSignerList.signers)
+ && Objects.equals(this.metadata, subBulkSignerList.metadata);
}
@Override
public int hashCode() {
- return Objects.hash(customFields, signers);
+ return Objects.hash(customFields, signers, metadata);
}
@Override
@@ -148,6 +187,7 @@ public String toString() {
sb.append("class SubBulkSignerList {\n");
sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n");
sb.append(" signers: ").append(toIndentedString(signers)).append("\n");
+ sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n");
sb.append("}");
return sb.toString();
}
@@ -194,6 +234,24 @@ public Map createFormData() throws ApiException {
map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers));
}
}
+ if (metadata != null) {
+ if (isFileTypeOrListOfFiles(metadata)) {
+ fileTypeFound = true;
+ }
+
+ if (metadata.getClass().equals(java.io.File.class)
+ || metadata.getClass().equals(Integer.class)
+ || metadata.getClass().equals(String.class)
+ || metadata.getClass().isEnum()) {
+ map.put("metadata", metadata);
+ } else if (isListOfFile(metadata)) {
+ for (int i = 0; i < getListSize(metadata); i++) {
+ map.put("metadata[" + i + "]", getFromList(metadata, i));
+ }
+ } else {
+ map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata));
+ }
+ }
} catch (Exception e) {
throw new ApiException(e);
}
diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java
index 2766e1d20..cbb3737c8 100644
--- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java
+++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java
@@ -24,7 +24,10 @@
import java.util.Objects;
/** TeamCreateRequest */
-@JsonPropertyOrder({TeamCreateRequest.JSON_PROPERTY_NAME})
+@JsonPropertyOrder({
+ TeamCreateRequest.JSON_PROPERTY_NAME,
+ TeamCreateRequest.JSON_PROPERTY_PARENT_TEAM_ID
+})
@javax.annotation.Generated(
value = "org.openapitools.codegen.languages.JavaClientCodegen",
comments = "Generator version: 7.12.0")
@@ -33,6 +36,9 @@ public class TeamCreateRequest {
public static final String JSON_PROPERTY_NAME = "name";
@javax.annotation.Nullable private String name = "Untitled Team";
+ public static final String JSON_PROPERTY_PARENT_TEAM_ID = "parent_team_id";
+ @javax.annotation.Nullable private String parentTeamId;
+
public TeamCreateRequest() {}
/**
@@ -71,6 +77,28 @@ public void setName(@javax.annotation.Nullable String name) {
this.name = name;
}
+ public TeamCreateRequest parentTeamId(@javax.annotation.Nullable String parentTeamId) {
+ this.parentTeamId = parentTeamId;
+ return this;
+ }
+
+ /**
+ * The id of the parent team. Set this to create the new team as a sub-team of that parent.
+ *
+ * @return parentTeamId
+ */
+ @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PARENT_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+ public String getParentTeamId() {
+ return parentTeamId;
+ }
+
+ @JsonProperty(JSON_PROPERTY_PARENT_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+ public void setParentTeamId(@javax.annotation.Nullable String parentTeamId) {
+ this.parentTeamId = parentTeamId;
+ }
+
/** Return true if this TeamCreateRequest object is equal to o. */
@Override
public boolean equals(Object o) {
@@ -81,12 +109,13 @@ public boolean equals(Object o) {
return false;
}
TeamCreateRequest teamCreateRequest = (TeamCreateRequest) o;
- return Objects.equals(this.name, teamCreateRequest.name);
+ return Objects.equals(this.name, teamCreateRequest.name)
+ && Objects.equals(this.parentTeamId, teamCreateRequest.parentTeamId);
}
@Override
public int hashCode() {
- return Objects.hash(name);
+ return Objects.hash(name, parentTeamId);
}
@Override
@@ -94,6 +123,7 @@ public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class TeamCreateRequest {\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
+ sb.append(" parentTeamId: ").append(toIndentedString(parentTeamId)).append("\n");
sb.append("}");
return sb.toString();
}
@@ -120,6 +150,26 @@ public Map createFormData() throws ApiException {
map.put("name", JSON.getDefault().getMapper().writeValueAsString(name));
}
}
+ if (parentTeamId != null) {
+ if (isFileTypeOrListOfFiles(parentTeamId)) {
+ fileTypeFound = true;
+ }
+
+ if (parentTeamId.getClass().equals(java.io.File.class)
+ || parentTeamId.getClass().equals(Integer.class)
+ || parentTeamId.getClass().equals(String.class)
+ || parentTeamId.getClass().isEnum()) {
+ map.put("parent_team_id", parentTeamId);
+ } else if (isListOfFile(parentTeamId)) {
+ for (int i = 0; i < getListSize(parentTeamId); i++) {
+ map.put("parent_team_id[" + i + "]", getFromList(parentTeamId, i));
+ }
+ } else {
+ map.put(
+ "parent_team_id",
+ JSON.getDefault().getMapper().writeValueAsString(parentTeamId));
+ }
+ }
} catch (Exception e) {
throw new ApiException(e);
}
diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java
index 6fcc0fd87..bd1030406 100644
--- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java
+++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java
@@ -27,6 +27,8 @@
/** Contains information about your team and its members */
@JsonPropertyOrder({
+ TeamResponse.JSON_PROPERTY_TEAM_ID,
+ TeamResponse.JSON_PROPERTY_PARENT_TEAM_ID,
TeamResponse.JSON_PROPERTY_NAME,
TeamResponse.JSON_PROPERTY_ACCOUNTS,
TeamResponse.JSON_PROPERTY_INVITED_ACCOUNTS,
@@ -37,6 +39,12 @@
comments = "Generator version: 7.12.0")
@JsonIgnoreProperties(ignoreUnknown = true)
public class TeamResponse {
+ public static final String JSON_PROPERTY_TEAM_ID = "team_id";
+ @javax.annotation.Nullable private String teamId;
+
+ public static final String JSON_PROPERTY_PARENT_TEAM_ID = "parent_team_id";
+ @javax.annotation.Nullable private String parentTeamId;
+
public static final String JSON_PROPERTY_NAME = "name";
@javax.annotation.Nullable private String name;
@@ -65,6 +73,50 @@ public static TeamResponse init(HashMap data) throws Exception {
.readValue(new ObjectMapper().writeValueAsString(data), TeamResponse.class);
}
+ public TeamResponse teamId(@javax.annotation.Nullable String teamId) {
+ this.teamId = teamId;
+ return this;
+ }
+
+ /**
+ * The id of a team
+ *
+ * @return teamId
+ */
+ @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+ public String getTeamId() {
+ return teamId;
+ }
+
+ @JsonProperty(JSON_PROPERTY_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+ public void setTeamId(@javax.annotation.Nullable String teamId) {
+ this.teamId = teamId;
+ }
+
+ public TeamResponse parentTeamId(@javax.annotation.Nullable String parentTeamId) {
+ this.parentTeamId = parentTeamId;
+ return this;
+ }
+
+ /**
+ * The id of this team's parent team.
+ *
+ * @return parentTeamId
+ */
+ @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PARENT_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+ public String getParentTeamId() {
+ return parentTeamId;
+ }
+
+ @JsonProperty(JSON_PROPERTY_PARENT_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+ public void setParentTeamId(@javax.annotation.Nullable String parentTeamId) {
+ this.parentTeamId = parentTeamId;
+ }
+
public TeamResponse name(@javax.annotation.Nullable String name) {
this.name = name;
return this;
@@ -191,7 +243,9 @@ public boolean equals(Object o) {
return false;
}
TeamResponse teamResponse = (TeamResponse) o;
- return Objects.equals(this.name, teamResponse.name)
+ return Objects.equals(this.teamId, teamResponse.teamId)
+ && Objects.equals(this.parentTeamId, teamResponse.parentTeamId)
+ && Objects.equals(this.name, teamResponse.name)
&& Objects.equals(this.accounts, teamResponse.accounts)
&& Objects.equals(this.invitedAccounts, teamResponse.invitedAccounts)
&& Objects.equals(this.invitedEmails, teamResponse.invitedEmails);
@@ -199,13 +253,15 @@ public boolean equals(Object o) {
@Override
public int hashCode() {
- return Objects.hash(name, accounts, invitedAccounts, invitedEmails);
+ return Objects.hash(teamId, parentTeamId, name, accounts, invitedAccounts, invitedEmails);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class TeamResponse {\n");
+ sb.append(" teamId: ").append(toIndentedString(teamId)).append("\n");
+ sb.append(" parentTeamId: ").append(toIndentedString(parentTeamId)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n");
sb.append(" invitedAccounts: ").append(toIndentedString(invitedAccounts)).append("\n");
@@ -218,6 +274,44 @@ public Map createFormData() throws ApiException {
Map map = new HashMap<>();
boolean fileTypeFound = false;
try {
+ if (teamId != null) {
+ if (isFileTypeOrListOfFiles(teamId)) {
+ fileTypeFound = true;
+ }
+
+ if (teamId.getClass().equals(java.io.File.class)
+ || teamId.getClass().equals(Integer.class)
+ || teamId.getClass().equals(String.class)
+ || teamId.getClass().isEnum()) {
+ map.put("team_id", teamId);
+ } else if (isListOfFile(teamId)) {
+ for (int i = 0; i < getListSize(teamId); i++) {
+ map.put("team_id[" + i + "]", getFromList(teamId, i));
+ }
+ } else {
+ map.put("team_id", JSON.getDefault().getMapper().writeValueAsString(teamId));
+ }
+ }
+ if (parentTeamId != null) {
+ if (isFileTypeOrListOfFiles(parentTeamId)) {
+ fileTypeFound = true;
+ }
+
+ if (parentTeamId.getClass().equals(java.io.File.class)
+ || parentTeamId.getClass().equals(Integer.class)
+ || parentTeamId.getClass().equals(String.class)
+ || parentTeamId.getClass().isEnum()) {
+ map.put("parent_team_id", parentTeamId);
+ } else if (isListOfFile(parentTeamId)) {
+ for (int i = 0; i < getListSize(parentTeamId); i++) {
+ map.put("parent_team_id[" + i + "]", getFromList(parentTeamId, i));
+ }
+ } else {
+ map.put(
+ "parent_team_id",
+ JSON.getDefault().getMapper().writeValueAsString(parentTeamId));
+ }
+ }
if (name != null) {
if (isFileTypeOrListOfFiles(name)) {
fileTypeFound = true;
diff --git a/sdks/java-v2/docs/SubBulkSignerList.md b/sdks/java-v2/docs/SubBulkSignerList.md
index 918c935b1..85b91dbf3 100644
--- a/sdks/java-v2/docs/SubBulkSignerList.md
+++ b/sdks/java-v2/docs/SubBulkSignerList.md
@@ -10,6 +10,7 @@
|------------ | ------------- | ------------- | -------------|
| `customFields` | [```List```](SubBulkSignerListCustomField.md) | An array of custom field values. | |
| `signers` | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
Currently only templates with a single role are supported. All signers must have the same `role` value. | |
+| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
diff --git a/sdks/java-v2/docs/TeamCreateRequest.md b/sdks/java-v2/docs/TeamCreateRequest.md
index 1a4861618..c66c6083e 100644
--- a/sdks/java-v2/docs/TeamCreateRequest.md
+++ b/sdks/java-v2/docs/TeamCreateRequest.md
@@ -9,6 +9,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| `name` | ```String``` | The name of your Team. | |
+| `parentTeamId` | ```String``` | The id of the parent team. Set this to create the new team as a sub-team of that parent. | |
diff --git a/sdks/java-v2/docs/TeamResponse.md b/sdks/java-v2/docs/TeamResponse.md
index ca6344cfc..3348936d3 100644
--- a/sdks/java-v2/docs/TeamResponse.md
+++ b/sdks/java-v2/docs/TeamResponse.md
@@ -8,6 +8,8 @@ Contains information about your team and its members
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
+| `teamId` | ```String``` | The id of a team | |
+| `parentTeamId` | ```String``` | The id of this team's parent team. | |
| `name` | ```String``` | The name of your Team | |
| `accounts` | [```List```](AccountResponse.md) | | |
| `invitedAccounts` | [```List```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | |
diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java
index beb21db0b..c579e09e0 100644
--- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java
+++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java
@@ -25,7 +25,9 @@
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.HashMap;
import java.util.List;
+import java.util.Map;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.dropbox.sign.JSON;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
@@ -38,7 +40,8 @@
*/
@JsonPropertyOrder({
SubBulkSignerList.JSON_PROPERTY_CUSTOM_FIELDS,
- SubBulkSignerList.JSON_PROPERTY_SIGNERS
+ SubBulkSignerList.JSON_PROPERTY_SIGNERS,
+ SubBulkSignerList.JSON_PROPERTY_METADATA
})
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0")
@JsonIgnoreProperties(ignoreUnknown=true)
@@ -51,6 +54,10 @@ public class SubBulkSignerList {
@jakarta.annotation.Nullable
private List signers = null;
+ public static final String JSON_PROPERTY_METADATA = "metadata";
+ @jakarta.annotation.Nullable
+ private Map metadata = null;
+
public SubBulkSignerList() {
}
@@ -135,6 +142,39 @@ public void setSigners(@jakarta.annotation.Nullable List metadata) {
+ this.metadata = metadata;
+ return this;
+ }
+
+ public SubBulkSignerList putMetadataItem(String key, Object metadataItem) {
+ if (this.metadata == null) {
+ this.metadata = new HashMap<>();
+ }
+ this.metadata.put(key, metadataItem);
+ return this;
+ }
+
+ /**
+ * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ * @return metadata
+ */
+ @jakarta.annotation.Nullable
+ @JsonProperty(JSON_PROPERTY_METADATA)
+ @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)
+
+ public Map getMetadata() {
+ return metadata;
+ }
+
+
+ @JsonProperty(JSON_PROPERTY_METADATA)
+ @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)
+ public void setMetadata(@jakarta.annotation.Nullable Map metadata) {
+ this.metadata = metadata;
+ }
+
+
/**
* Return true if this SubBulkSignerList object is equal to o.
*/
@@ -148,12 +188,13 @@ public boolean equals(Object o) {
}
SubBulkSignerList subBulkSignerList = (SubBulkSignerList) o;
return Objects.equals(this.customFields, subBulkSignerList.customFields) &&
- Objects.equals(this.signers, subBulkSignerList.signers);
+ Objects.equals(this.signers, subBulkSignerList.signers) &&
+ Objects.equals(this.metadata, subBulkSignerList.metadata);
}
@Override
public int hashCode() {
- return Objects.hash(customFields, signers);
+ return Objects.hash(customFields, signers, metadata);
}
@Override
@@ -162,6 +203,7 @@ public String toString() {
sb.append("class SubBulkSignerList {\n");
sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n");
sb.append(" signers: ").append(toIndentedString(signers)).append("\n");
+ sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n");
sb.append("}");
return sb.toString();
}
@@ -208,6 +250,25 @@ public Map createFormData() throws ApiException {
map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers));
}
}
+ if (metadata != null) {
+ if (isFileTypeOrListOfFiles(metadata)) {
+ fileTypeFound = true;
+ }
+
+ if (metadata.getClass().equals(java.io.File.class) ||
+ metadata.getClass().equals(Integer.class) ||
+ metadata.getClass().equals(String.class) ||
+ metadata.getClass().isEnum()) {
+ map.put("metadata", metadata);
+ } else if (isListOfFile(metadata)) {
+ for(int i = 0; i< getListSize(metadata); i++) {
+ map.put("metadata[" + i + "]", getFromList(metadata, i));
+ }
+ }
+ else {
+ map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata));
+ }
+ }
} catch (Exception e) {
throw new ApiException(e);
}
diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java
index f5b0e92ad..cf764bcca 100644
--- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java
+++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java
@@ -33,7 +33,8 @@
* TeamCreateRequest
*/
@JsonPropertyOrder({
- TeamCreateRequest.JSON_PROPERTY_NAME
+ TeamCreateRequest.JSON_PROPERTY_NAME,
+ TeamCreateRequest.JSON_PROPERTY_PARENT_TEAM_ID
})
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0")
@JsonIgnoreProperties(ignoreUnknown=true)
@@ -42,6 +43,10 @@ public class TeamCreateRequest {
@jakarta.annotation.Nullable
private String name = "Untitled Team";
+ public static final String JSON_PROPERTY_PARENT_TEAM_ID = "parent_team_id";
+ @jakarta.annotation.Nullable
+ private String parentTeamId;
+
public TeamCreateRequest() {
}
@@ -85,6 +90,31 @@ public void setName(@jakarta.annotation.Nullable String name) {
}
+ public TeamCreateRequest parentTeamId(@jakarta.annotation.Nullable String parentTeamId) {
+ this.parentTeamId = parentTeamId;
+ return this;
+ }
+
+ /**
+ * The id of the parent team. Set this to create the new team as a sub-team of that parent.
+ * @return parentTeamId
+ */
+ @jakarta.annotation.Nullable
+ @JsonProperty(JSON_PROPERTY_PARENT_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+
+ public String getParentTeamId() {
+ return parentTeamId;
+ }
+
+
+ @JsonProperty(JSON_PROPERTY_PARENT_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+ public void setParentTeamId(@jakarta.annotation.Nullable String parentTeamId) {
+ this.parentTeamId = parentTeamId;
+ }
+
+
/**
* Return true if this TeamCreateRequest object is equal to o.
*/
@@ -97,12 +127,13 @@ public boolean equals(Object o) {
return false;
}
TeamCreateRequest teamCreateRequest = (TeamCreateRequest) o;
- return Objects.equals(this.name, teamCreateRequest.name);
+ return Objects.equals(this.name, teamCreateRequest.name) &&
+ Objects.equals(this.parentTeamId, teamCreateRequest.parentTeamId);
}
@Override
public int hashCode() {
- return Objects.hash(name);
+ return Objects.hash(name, parentTeamId);
}
@Override
@@ -110,6 +141,7 @@ public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class TeamCreateRequest {\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
+ sb.append(" parentTeamId: ").append(toIndentedString(parentTeamId)).append("\n");
sb.append("}");
return sb.toString();
}
@@ -137,6 +169,25 @@ public Map createFormData() throws ApiException {
map.put("name", JSON.getDefault().getMapper().writeValueAsString(name));
}
}
+ if (parentTeamId != null) {
+ if (isFileTypeOrListOfFiles(parentTeamId)) {
+ fileTypeFound = true;
+ }
+
+ if (parentTeamId.getClass().equals(java.io.File.class) ||
+ parentTeamId.getClass().equals(Integer.class) ||
+ parentTeamId.getClass().equals(String.class) ||
+ parentTeamId.getClass().isEnum()) {
+ map.put("parent_team_id", parentTeamId);
+ } else if (isListOfFile(parentTeamId)) {
+ for(int i = 0; i< getListSize(parentTeamId); i++) {
+ map.put("parent_team_id[" + i + "]", getFromList(parentTeamId, i));
+ }
+ }
+ else {
+ map.put("parent_team_id", JSON.getDefault().getMapper().writeValueAsString(parentTeamId));
+ }
+ }
} catch (Exception e) {
throw new ApiException(e);
}
diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java
index 37128c92a..f31c5ef88 100644
--- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java
+++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java
@@ -36,6 +36,8 @@
* Contains information about your team and its members
*/
@JsonPropertyOrder({
+ TeamResponse.JSON_PROPERTY_TEAM_ID,
+ TeamResponse.JSON_PROPERTY_PARENT_TEAM_ID,
TeamResponse.JSON_PROPERTY_NAME,
TeamResponse.JSON_PROPERTY_ACCOUNTS,
TeamResponse.JSON_PROPERTY_INVITED_ACCOUNTS,
@@ -44,6 +46,14 @@
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0")
@JsonIgnoreProperties(ignoreUnknown=true)
public class TeamResponse {
+ public static final String JSON_PROPERTY_TEAM_ID = "team_id";
+ @jakarta.annotation.Nullable
+ private String teamId;
+
+ public static final String JSON_PROPERTY_PARENT_TEAM_ID = "parent_team_id";
+ @jakarta.annotation.Nullable
+ private String parentTeamId;
+
public static final String JSON_PROPERTY_NAME = "name";
@jakarta.annotation.Nullable
private String name;
@@ -78,6 +88,56 @@ static public TeamResponse init(HashMap data) throws Exception {
);
}
+ public TeamResponse teamId(@jakarta.annotation.Nullable String teamId) {
+ this.teamId = teamId;
+ return this;
+ }
+
+ /**
+ * The id of a team
+ * @return teamId
+ */
+ @jakarta.annotation.Nullable
+ @JsonProperty(JSON_PROPERTY_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+
+ public String getTeamId() {
+ return teamId;
+ }
+
+
+ @JsonProperty(JSON_PROPERTY_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+ public void setTeamId(@jakarta.annotation.Nullable String teamId) {
+ this.teamId = teamId;
+ }
+
+
+ public TeamResponse parentTeamId(@jakarta.annotation.Nullable String parentTeamId) {
+ this.parentTeamId = parentTeamId;
+ return this;
+ }
+
+ /**
+ * The id of this team's parent team.
+ * @return parentTeamId
+ */
+ @jakarta.annotation.Nullable
+ @JsonProperty(JSON_PROPERTY_PARENT_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+
+ public String getParentTeamId() {
+ return parentTeamId;
+ }
+
+
+ @JsonProperty(JSON_PROPERTY_PARENT_TEAM_ID)
+ @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+ public void setParentTeamId(@jakarta.annotation.Nullable String parentTeamId) {
+ this.parentTeamId = parentTeamId;
+ }
+
+
public TeamResponse name(@jakarta.annotation.Nullable String name) {
this.name = name;
return this;
@@ -214,7 +274,9 @@ public boolean equals(Object o) {
return false;
}
TeamResponse teamResponse = (TeamResponse) o;
- return Objects.equals(this.name, teamResponse.name) &&
+ return Objects.equals(this.teamId, teamResponse.teamId) &&
+ Objects.equals(this.parentTeamId, teamResponse.parentTeamId) &&
+ Objects.equals(this.name, teamResponse.name) &&
Objects.equals(this.accounts, teamResponse.accounts) &&
Objects.equals(this.invitedAccounts, teamResponse.invitedAccounts) &&
Objects.equals(this.invitedEmails, teamResponse.invitedEmails);
@@ -222,13 +284,15 @@ public boolean equals(Object o) {
@Override
public int hashCode() {
- return Objects.hash(name, accounts, invitedAccounts, invitedEmails);
+ return Objects.hash(teamId, parentTeamId, name, accounts, invitedAccounts, invitedEmails);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class TeamResponse {\n");
+ sb.append(" teamId: ").append(toIndentedString(teamId)).append("\n");
+ sb.append(" parentTeamId: ").append(toIndentedString(parentTeamId)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n");
sb.append(" invitedAccounts: ").append(toIndentedString(invitedAccounts)).append("\n");
@@ -241,6 +305,44 @@ public Map createFormData() throws ApiException {
Map map = new HashMap<>();
boolean fileTypeFound = false;
try {
+ if (teamId != null) {
+ if (isFileTypeOrListOfFiles(teamId)) {
+ fileTypeFound = true;
+ }
+
+ if (teamId.getClass().equals(java.io.File.class) ||
+ teamId.getClass().equals(Integer.class) ||
+ teamId.getClass().equals(String.class) ||
+ teamId.getClass().isEnum()) {
+ map.put("team_id", teamId);
+ } else if (isListOfFile(teamId)) {
+ for(int i = 0; i< getListSize(teamId); i++) {
+ map.put("team_id[" + i + "]", getFromList(teamId, i));
+ }
+ }
+ else {
+ map.put("team_id", JSON.getDefault().getMapper().writeValueAsString(teamId));
+ }
+ }
+ if (parentTeamId != null) {
+ if (isFileTypeOrListOfFiles(parentTeamId)) {
+ fileTypeFound = true;
+ }
+
+ if (parentTeamId.getClass().equals(java.io.File.class) ||
+ parentTeamId.getClass().equals(Integer.class) ||
+ parentTeamId.getClass().equals(String.class) ||
+ parentTeamId.getClass().isEnum()) {
+ map.put("parent_team_id", parentTeamId);
+ } else if (isListOfFile(parentTeamId)) {
+ for(int i = 0; i< getListSize(parentTeamId); i++) {
+ map.put("parent_team_id[" + i + "]", getFromList(parentTeamId, i));
+ }
+ }
+ else {
+ map.put("parent_team_id", JSON.getDefault().getMapper().writeValueAsString(parentTeamId));
+ }
+ }
if (name != null) {
if (isFileTypeOrListOfFiles(name)) {
fileTypeFound = true;
diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js
index 2acb8bb12..c1c177190 100644
--- a/sdks/node/dist/api.js
+++ b/sdks/node/dist/api.js
@@ -25000,6 +25000,11 @@ var SubBulkSignerList = class _SubBulkSignerList {
name: "signers",
baseName: "signers",
type: "Array"
+ },
+ {
+ name: "metadata",
+ baseName: "metadata",
+ type: "{ [key: string]: any; }"
}
];
}
@@ -26722,6 +26727,11 @@ var TeamCreateRequest = class _TeamCreateRequest {
name: "name",
baseName: "name",
type: "string"
+ },
+ {
+ name: "parentTeamId",
+ baseName: "parent_team_id",
+ type: "string"
}
];
}
@@ -27062,6 +27072,16 @@ var TeamResponse = class _TeamResponse {
}
static {
this.attributeTypeMap = [
+ {
+ name: "teamId",
+ baseName: "team_id",
+ type: "string"
+ },
+ {
+ name: "parentTeamId",
+ baseName: "parent_team_id",
+ type: "string"
+ },
{
name: "name",
baseName: "name",
diff --git a/sdks/node/docs/model/SubBulkSignerList.md b/sdks/node/docs/model/SubBulkSignerList.md
index 38606dea6..2813563b8 100644
--- a/sdks/node/docs/model/SubBulkSignerList.md
+++ b/sdks/node/docs/model/SubBulkSignerList.md
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `customFields` | [```Array```](SubBulkSignerListCustomField.md) | An array of custom field values. | |
| `signers` | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
Currently only templates with a single role are supported. All signers must have the same `role` value. | |
+| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/sdks/node/docs/model/TeamCreateRequest.md b/sdks/node/docs/model/TeamCreateRequest.md
index 29c05f9a3..47d42b14d 100644
--- a/sdks/node/docs/model/TeamCreateRequest.md
+++ b/sdks/node/docs/model/TeamCreateRequest.md
@@ -7,5 +7,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `name` | ```string``` | The name of your Team. | [default to 'Untitled Team'] |
+| `parentTeamId` | ```string``` | The id of the parent team. Set this to create the new team as a sub-team of that parent. | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/sdks/node/docs/model/TeamResponse.md b/sdks/node/docs/model/TeamResponse.md
index 39f6ae7fb..9fae7c7c9 100644
--- a/sdks/node/docs/model/TeamResponse.md
+++ b/sdks/node/docs/model/TeamResponse.md
@@ -6,6 +6,8 @@ Contains information about your team and its members
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
+| `teamId` | ```string``` | The id of a team | |
+| `parentTeamId` | ```string``` | The id of this team's parent team. | |
| `name` | ```string``` | The name of your Team | |
| `accounts` | [```Array```](AccountResponse.md) | | |
| `invitedAccounts` | [```Array```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | |
diff --git a/sdks/node/model/subBulkSignerList.ts b/sdks/node/model/subBulkSignerList.ts
index 46a11d1e5..d877777b6 100644
--- a/sdks/node/model/subBulkSignerList.ts
+++ b/sdks/node/model/subBulkSignerList.ts
@@ -35,6 +35,10 @@ export class SubBulkSignerList {
* Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. Currently only templates with a single role are supported. All signers must have the same `role` value.
*/
"signers"?: Array;
+ /**
+ * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ */
+ "metadata"?: { [key: string]: any };
static discriminator: string | undefined = undefined;
@@ -49,6 +53,11 @@ export class SubBulkSignerList {
baseName: "signers",
type: "Array",
},
+ {
+ name: "metadata",
+ baseName: "metadata",
+ type: "{ [key: string]: any; }",
+ },
];
static getAttributeTypeMap(): AttributeTypeMap {
diff --git a/sdks/node/model/teamCreateRequest.ts b/sdks/node/model/teamCreateRequest.ts
index 7439b337d..39192b502 100644
--- a/sdks/node/model/teamCreateRequest.ts
+++ b/sdks/node/model/teamCreateRequest.ts
@@ -29,6 +29,10 @@ export class TeamCreateRequest {
* The name of your Team.
*/
"name"?: string = "Untitled Team";
+ /**
+ * The id of the parent team. Set this to create the new team as a sub-team of that parent.
+ */
+ "parentTeamId"?: string;
static discriminator: string | undefined = undefined;
@@ -38,6 +42,11 @@ export class TeamCreateRequest {
baseName: "name",
type: "string",
},
+ {
+ name: "parentTeamId",
+ baseName: "parent_team_id",
+ type: "string",
+ },
];
static getAttributeTypeMap(): AttributeTypeMap {
diff --git a/sdks/node/model/teamResponse.ts b/sdks/node/model/teamResponse.ts
index 4d0a233d0..f4224696c 100644
--- a/sdks/node/model/teamResponse.ts
+++ b/sdks/node/model/teamResponse.ts
@@ -29,6 +29,14 @@ import { AccountResponse } from "./accountResponse";
* Contains information about your team and its members
*/
export class TeamResponse {
+ /**
+ * The id of a team
+ */
+ "teamId"?: string;
+ /**
+ * The id of this team\'s parent team.
+ */
+ "parentTeamId"?: string;
/**
* The name of your Team
*/
@@ -46,6 +54,16 @@ export class TeamResponse {
static discriminator: string | undefined = undefined;
static attributeTypeMap: AttributeTypeMap = [
+ {
+ name: "teamId",
+ baseName: "team_id",
+ type: "string",
+ },
+ {
+ name: "parentTeamId",
+ baseName: "parent_team_id",
+ type: "string",
+ },
{
name: "name",
baseName: "name",
diff --git a/sdks/node/types/model/subBulkSignerList.d.ts b/sdks/node/types/model/subBulkSignerList.d.ts
index 096e0464f..57556dda9 100644
--- a/sdks/node/types/model/subBulkSignerList.d.ts
+++ b/sdks/node/types/model/subBulkSignerList.d.ts
@@ -4,6 +4,9 @@ import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplate
export declare class SubBulkSignerList {
"customFields"?: Array;
"signers"?: Array;
+ "metadata"?: {
+ [key: string]: any;
+ };
static discriminator: string | undefined;
static attributeTypeMap: AttributeTypeMap;
static getAttributeTypeMap(): AttributeTypeMap;
diff --git a/sdks/node/types/model/teamCreateRequest.d.ts b/sdks/node/types/model/teamCreateRequest.d.ts
index 51c712ac8..ca07d1319 100644
--- a/sdks/node/types/model/teamCreateRequest.d.ts
+++ b/sdks/node/types/model/teamCreateRequest.d.ts
@@ -1,6 +1,7 @@
import { AttributeTypeMap } from "./";
export declare class TeamCreateRequest {
"name"?: string;
+ "parentTeamId"?: string;
static discriminator: string | undefined;
static attributeTypeMap: AttributeTypeMap;
static getAttributeTypeMap(): AttributeTypeMap;
diff --git a/sdks/node/types/model/teamResponse.d.ts b/sdks/node/types/model/teamResponse.d.ts
index cb7861bd9..88b33de4b 100644
--- a/sdks/node/types/model/teamResponse.d.ts
+++ b/sdks/node/types/model/teamResponse.d.ts
@@ -1,6 +1,8 @@
import { AttributeTypeMap } from "./";
import { AccountResponse } from "./accountResponse";
export declare class TeamResponse {
+ "teamId"?: string;
+ "parentTeamId"?: string;
"name"?: string;
"accounts"?: Array;
"invitedAccounts"?: Array;
diff --git a/sdks/php/docs/Model/SubBulkSignerList.md b/sdks/php/docs/Model/SubBulkSignerList.md
index 9842742e5..02b662550 100644
--- a/sdks/php/docs/Model/SubBulkSignerList.md
+++ b/sdks/php/docs/Model/SubBulkSignerList.md
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `custom_fields` | [```\Dropbox\Sign\Model\SubBulkSignerListCustomField[]```](SubBulkSignerListCustomField.md) | An array of custom field values. | |
| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
Currently only templates with a single role are supported. All signers must have the same `role` value. | |
+| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/sdks/php/docs/Model/TeamCreateRequest.md b/sdks/php/docs/Model/TeamCreateRequest.md
index 29c05f9a3..aa46329b4 100644
--- a/sdks/php/docs/Model/TeamCreateRequest.md
+++ b/sdks/php/docs/Model/TeamCreateRequest.md
@@ -7,5 +7,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `name` | ```string``` | The name of your Team. | [default to 'Untitled Team'] |
+| `parent_team_id` | ```string``` | The id of the parent team. Set this to create the new team as a sub-team of that parent. | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/sdks/php/docs/Model/TeamResponse.md b/sdks/php/docs/Model/TeamResponse.md
index 4aea582c9..9f4622f14 100644
--- a/sdks/php/docs/Model/TeamResponse.md
+++ b/sdks/php/docs/Model/TeamResponse.md
@@ -6,6 +6,8 @@ Contains information about your team and its members
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
+| `team_id` | ```string``` | The id of a team | |
+| `parent_team_id` | ```string``` | The id of this team's parent team. | |
| `name` | ```string``` | The name of your Team | |
| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | |
| `invited_accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | |
diff --git a/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php
index ce85cb62f..44a9d68cc 100644
--- a/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php
+++ b/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php
@@ -385,6 +385,10 @@ public function listInvalidProperties()
$invalidProperties[] = "invalid value for 'message', the character length must be smaller than or equal to 5000.";
}
+ if (!is_null($this->container['metadata']) && (count($this->container['metadata']) > 10)) {
+ $invalidProperties[] = "invalid value for 'metadata', number of items must be less than or equal to 10.";
+ }
+
if (!is_null($this->container['subject']) && (mb_strlen($this->container['subject']) > 255)) {
$invalidProperties[] = "invalid value for 'subject', the character length must be smaller than or equal to 255.";
}
@@ -650,6 +654,9 @@ public function setMetadata(?array $metadata)
throw new InvalidArgumentException('non-nullable metadata cannot be null');
}
+ if (count($metadata) > 10) {
+ throw new InvalidArgumentException('invalid value for $metadata when calling SignatureRequestBulkCreateEmbeddedWithTemplateRequest., number of items must be less than or equal to 10.');
+ }
$this->container['metadata'] = $metadata;
return $this;
diff --git a/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php
index 13c584b47..31d733e4e 100644
--- a/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php
+++ b/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php
@@ -382,6 +382,10 @@ public function listInvalidProperties()
$invalidProperties[] = "invalid value for 'message', the character length must be smaller than or equal to 5000.";
}
+ if (!is_null($this->container['metadata']) && (count($this->container['metadata']) > 10)) {
+ $invalidProperties[] = "invalid value for 'metadata', number of items must be less than or equal to 10.";
+ }
+
if (!is_null($this->container['subject']) && (mb_strlen($this->container['subject']) > 255)) {
$invalidProperties[] = "invalid value for 'subject', the character length must be smaller than or equal to 255.";
}
@@ -647,6 +651,9 @@ public function setMetadata(?array $metadata)
throw new InvalidArgumentException('non-nullable metadata cannot be null');
}
+ if (count($metadata) > 10) {
+ throw new InvalidArgumentException('invalid value for $metadata when calling SignatureRequestBulkSendWithTemplateRequest., number of items must be less than or equal to 10.');
+ }
$this->container['metadata'] = $metadata;
return $this;
diff --git a/sdks/php/src/Model/SubBulkSignerList.php b/sdks/php/src/Model/SubBulkSignerList.php
index 795441cb3..80c51249e 100644
--- a/sdks/php/src/Model/SubBulkSignerList.php
+++ b/sdks/php/src/Model/SubBulkSignerList.php
@@ -59,6 +59,7 @@ class SubBulkSignerList implements ModelInterface, ArrayAccess, JsonSerializable
protected static $openAPITypes = [
'custom_fields' => '\Dropbox\Sign\Model\SubBulkSignerListCustomField[]',
'signers' => '\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]',
+ 'metadata' => 'array',
];
/**
@@ -71,6 +72,7 @@ class SubBulkSignerList implements ModelInterface, ArrayAccess, JsonSerializable
protected static $openAPIFormats = [
'custom_fields' => null,
'signers' => null,
+ 'metadata' => null,
];
/**
@@ -81,6 +83,7 @@ class SubBulkSignerList implements ModelInterface, ArrayAccess, JsonSerializable
protected static array $openAPINullables = [
'custom_fields' => false,
'signers' => false,
+ 'metadata' => false,
];
/**
@@ -163,6 +166,7 @@ public function isNullableSetToNull(string $property): bool
protected static $attributeMap = [
'custom_fields' => 'custom_fields',
'signers' => 'signers',
+ 'metadata' => 'metadata',
];
/**
@@ -173,6 +177,7 @@ public function isNullableSetToNull(string $property): bool
protected static $setters = [
'custom_fields' => 'setCustomFields',
'signers' => 'setSigners',
+ 'metadata' => 'setMetadata',
];
/**
@@ -183,6 +188,7 @@ public function isNullableSetToNull(string $property): bool
protected static $getters = [
'custom_fields' => 'getCustomFields',
'signers' => 'getSigners',
+ 'metadata' => 'getMetadata',
];
/**
@@ -243,6 +249,7 @@ public function __construct(?array $data = null)
{
$this->setIfExists('custom_fields', $data ?? [], null);
$this->setIfExists('signers', $data ?? [], null);
+ $this->setIfExists('metadata', $data ?? [], null);
}
/**
@@ -288,7 +295,13 @@ private function setIfExists(string $variableName, array $fields, $defaultValue)
*/
public function listInvalidProperties()
{
- return [];
+ $invalidProperties = [];
+
+ if (!is_null($this->container['metadata']) && (count($this->container['metadata']) > 10)) {
+ $invalidProperties[] = "invalid value for 'metadata', number of items must be less than or equal to 10.";
+ }
+
+ return $invalidProperties;
}
/**
@@ -356,6 +369,37 @@ public function setSigners(?array $signers)
return $this;
}
+ /**
+ * Gets metadata
+ *
+ * @return array|null
+ */
+ public function getMetadata()
+ {
+ return $this->container['metadata'];
+ }
+
+ /**
+ * Sets metadata
+ *
+ * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ *
+ * @return self
+ */
+ public function setMetadata(?array $metadata)
+ {
+ if (is_null($metadata)) {
+ throw new InvalidArgumentException('non-nullable metadata cannot be null');
+ }
+
+ if (count($metadata) > 10) {
+ throw new InvalidArgumentException('invalid value for $metadata when calling SubBulkSignerList., number of items must be less than or equal to 10.');
+ }
+ $this->container['metadata'] = $metadata;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/sdks/php/src/Model/TeamCreateRequest.php b/sdks/php/src/Model/TeamCreateRequest.php
index 452badc96..586981784 100644
--- a/sdks/php/src/Model/TeamCreateRequest.php
+++ b/sdks/php/src/Model/TeamCreateRequest.php
@@ -58,6 +58,7 @@ class TeamCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable
*/
protected static $openAPITypes = [
'name' => 'string',
+ 'parent_team_id' => 'string',
];
/**
@@ -69,6 +70,7 @@ class TeamCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable
*/
protected static $openAPIFormats = [
'name' => null,
+ 'parent_team_id' => null,
];
/**
@@ -78,6 +80,7 @@ class TeamCreateRequest implements ModelInterface, ArrayAccess, JsonSerializable
*/
protected static array $openAPINullables = [
'name' => false,
+ 'parent_team_id' => false,
];
/**
@@ -159,6 +162,7 @@ public function isNullableSetToNull(string $property): bool
*/
protected static $attributeMap = [
'name' => 'name',
+ 'parent_team_id' => 'parent_team_id',
];
/**
@@ -168,6 +172,7 @@ public function isNullableSetToNull(string $property): bool
*/
protected static $setters = [
'name' => 'setName',
+ 'parent_team_id' => 'setParentTeamId',
];
/**
@@ -177,6 +182,7 @@ public function isNullableSetToNull(string $property): bool
*/
protected static $getters = [
'name' => 'getName',
+ 'parent_team_id' => 'getParentTeamId',
];
/**
@@ -236,6 +242,7 @@ public function getModelName()
public function __construct(?array $data = null)
{
$this->setIfExists('name', $data ?? [], 'Untitled Team');
+ $this->setIfExists('parent_team_id', $data ?? [], null);
}
/**
@@ -322,6 +329,33 @@ public function setName(?string $name)
return $this;
}
+ /**
+ * Gets parent_team_id
+ *
+ * @return string|null
+ */
+ public function getParentTeamId()
+ {
+ return $this->container['parent_team_id'];
+ }
+
+ /**
+ * Sets parent_team_id
+ *
+ * @param string|null $parent_team_id The id of the parent team. Set this to create the new team as a sub-team of that parent.
+ *
+ * @return self
+ */
+ public function setParentTeamId(?string $parent_team_id)
+ {
+ if (is_null($parent_team_id)) {
+ throw new InvalidArgumentException('non-nullable parent_team_id cannot be null');
+ }
+ $this->container['parent_team_id'] = $parent_team_id;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/sdks/php/src/Model/TeamResponse.php b/sdks/php/src/Model/TeamResponse.php
index ca161d761..62f8609d9 100644
--- a/sdks/php/src/Model/TeamResponse.php
+++ b/sdks/php/src/Model/TeamResponse.php
@@ -58,6 +58,8 @@ class TeamResponse implements ModelInterface, ArrayAccess, JsonSerializable
* @var string[]
*/
protected static $openAPITypes = [
+ 'team_id' => 'string',
+ 'parent_team_id' => 'string',
'name' => 'string',
'accounts' => '\Dropbox\Sign\Model\AccountResponse[]',
'invited_accounts' => '\Dropbox\Sign\Model\AccountResponse[]',
@@ -72,6 +74,8 @@ class TeamResponse implements ModelInterface, ArrayAccess, JsonSerializable
* @psalm-var array
*/
protected static $openAPIFormats = [
+ 'team_id' => null,
+ 'parent_team_id' => null,
'name' => null,
'accounts' => null,
'invited_accounts' => null,
@@ -84,6 +88,8 @@ class TeamResponse implements ModelInterface, ArrayAccess, JsonSerializable
* @var bool[]
*/
protected static array $openAPINullables = [
+ 'team_id' => false,
+ 'parent_team_id' => false,
'name' => false,
'accounts' => false,
'invited_accounts' => false,
@@ -168,6 +174,8 @@ public function isNullableSetToNull(string $property): bool
* @var string[]
*/
protected static $attributeMap = [
+ 'team_id' => 'team_id',
+ 'parent_team_id' => 'parent_team_id',
'name' => 'name',
'accounts' => 'accounts',
'invited_accounts' => 'invited_accounts',
@@ -180,6 +188,8 @@ public function isNullableSetToNull(string $property): bool
* @var string[]
*/
protected static $setters = [
+ 'team_id' => 'setTeamId',
+ 'parent_team_id' => 'setParentTeamId',
'name' => 'setName',
'accounts' => 'setAccounts',
'invited_accounts' => 'setInvitedAccounts',
@@ -192,6 +202,8 @@ public function isNullableSetToNull(string $property): bool
* @var string[]
*/
protected static $getters = [
+ 'team_id' => 'getTeamId',
+ 'parent_team_id' => 'getParentTeamId',
'name' => 'getName',
'accounts' => 'getAccounts',
'invited_accounts' => 'getInvitedAccounts',
@@ -254,6 +266,8 @@ public function getModelName()
*/
public function __construct(?array $data = null)
{
+ $this->setIfExists('team_id', $data ?? [], null);
+ $this->setIfExists('parent_team_id', $data ?? [], null);
$this->setIfExists('name', $data ?? [], null);
$this->setIfExists('accounts', $data ?? [], null);
$this->setIfExists('invited_accounts', $data ?? [], null);
@@ -317,6 +331,60 @@ public function valid()
return count($this->listInvalidProperties()) === 0;
}
+ /**
+ * Gets team_id
+ *
+ * @return string|null
+ */
+ public function getTeamId()
+ {
+ return $this->container['team_id'];
+ }
+
+ /**
+ * Sets team_id
+ *
+ * @param string|null $team_id The id of a team
+ *
+ * @return self
+ */
+ public function setTeamId(?string $team_id)
+ {
+ if (is_null($team_id)) {
+ throw new InvalidArgumentException('non-nullable team_id cannot be null');
+ }
+ $this->container['team_id'] = $team_id;
+
+ return $this;
+ }
+
+ /**
+ * Gets parent_team_id
+ *
+ * @return string|null
+ */
+ public function getParentTeamId()
+ {
+ return $this->container['parent_team_id'];
+ }
+
+ /**
+ * Sets parent_team_id
+ *
+ * @param string|null $parent_team_id the id of this team's parent team
+ *
+ * @return self
+ */
+ public function setParentTeamId(?string $parent_team_id)
+ {
+ if (is_null($parent_team_id)) {
+ throw new InvalidArgumentException('non-nullable parent_team_id cannot be null');
+ }
+ $this->container['parent_team_id'] = $parent_team_id;
+
+ return $this;
+ }
+
/**
* Gets name
*
diff --git a/sdks/python/docs/SubBulkSignerList.md b/sdks/python/docs/SubBulkSignerList.md
index 21df799f7..9951199b2 100644
--- a/sdks/python/docs/SubBulkSignerList.md
+++ b/sdks/python/docs/SubBulkSignerList.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `custom_fields` | [```List[SubBulkSignerListCustomField]```](SubBulkSignerListCustomField.md) | An array of custom field values. | |
| `signers` | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
Currently only templates with a single role are supported. All signers must have the same `role` value. | |
+| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/sdks/python/docs/TeamCreateRequest.md b/sdks/python/docs/TeamCreateRequest.md
index 8491afc10..dfaa51cd9 100644
--- a/sdks/python/docs/TeamCreateRequest.md
+++ b/sdks/python/docs/TeamCreateRequest.md
@@ -6,6 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `name` | ```str``` | The name of your Team. | [default to 'Untitled Team'] |
+| `parent_team_id` | ```str``` | The id of the parent team. Set this to create the new team as a sub-team of that parent. | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/sdks/python/docs/TeamResponse.md b/sdks/python/docs/TeamResponse.md
index f8b211bdf..0b2b4054d 100644
--- a/sdks/python/docs/TeamResponse.md
+++ b/sdks/python/docs/TeamResponse.md
@@ -5,6 +5,8 @@ Contains information about your team and its members
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
+| `team_id` | ```str``` | The id of a team | |
+| `parent_team_id` | ```str``` | The id of this team's parent team. | |
| `name` | ```str``` | The name of your Team | |
| `accounts` | [```List[AccountResponse]```](AccountResponse.md) | | |
| `invited_accounts` | [```List[AccountResponse]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | |
diff --git a/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py b/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py
index 899f57701..8d1af8443 100644
--- a/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py
+++ b/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py
@@ -45,7 +45,11 @@ class SubBulkSignerList(BaseModel):
default=None,
description="Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. Currently only templates with a single role are supported. All signers must have the same `role` value.",
)
- __properties: ClassVar[List[str]] = ["custom_fields", "signers"]
+ metadata: Optional[Dict[str, Any]] = Field(
+ default=None,
+ description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.",
+ )
+ __properties: ClassVar[List[str]] = ["custom_fields", "signers", "metadata"]
model_config = ConfigDict(
populate_by_name=True,
@@ -140,6 +144,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
if obj.get("signers") is not None
else None
),
+ "metadata": obj.get("metadata"),
}
)
return _obj
@@ -159,6 +164,7 @@ def openapi_types(cls) -> Dict[str, str]:
return {
"custom_fields": "(List[SubBulkSignerListCustomField],)",
"signers": "(List[SubSignatureRequestTemplateSigner],)",
+ "metadata": "(Dict[str, object],)",
}
@classmethod
diff --git a/sdks/python/dropbox_sign/models/team_create_request.py b/sdks/python/dropbox_sign/models/team_create_request.py
index 94d38e66b..b5a920348 100644
--- a/sdks/python/dropbox_sign/models/team_create_request.py
+++ b/sdks/python/dropbox_sign/models/team_create_request.py
@@ -35,7 +35,11 @@ class TeamCreateRequest(BaseModel):
name: Optional[StrictStr] = Field(
default="Untitled Team", description="The name of your Team."
)
- __properties: ClassVar[List[str]] = ["name"]
+ parent_team_id: Optional[StrictStr] = Field(
+ default=None,
+ description="The id of the parent team. Set this to create the new team as a sub-team of that parent.",
+ )
+ __properties: ClassVar[List[str]] = ["name", "parent_team_id"]
model_config = ConfigDict(
populate_by_name=True,
@@ -102,7 +106,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
{
"name": (
obj.get("name") if obj.get("name") is not None else "Untitled Team"
- )
+ ),
+ "parent_team_id": obj.get("parent_team_id"),
}
)
return _obj
@@ -121,6 +126,7 @@ def init(cls, data: Any) -> Self:
def openapi_types(cls) -> Dict[str, str]:
return {
"name": "(str,)",
+ "parent_team_id": "(str,)",
}
@classmethod
diff --git a/sdks/python/dropbox_sign/models/team_response.py b/sdks/python/dropbox_sign/models/team_response.py
index 9f72e11fe..8819d6c75 100644
--- a/sdks/python/dropbox_sign/models/team_response.py
+++ b/sdks/python/dropbox_sign/models/team_response.py
@@ -33,6 +33,10 @@ class TeamResponse(BaseModel):
Contains information about your team and its members
""" # noqa: E501
+ team_id: Optional[StrictStr] = Field(default=None, description="The id of a team")
+ parent_team_id: Optional[StrictStr] = Field(
+ default=None, description="The id of this team's parent team."
+ )
name: Optional[StrictStr] = Field(default=None, description="The name of your Team")
accounts: Optional[List[AccountResponse]] = None
invited_accounts: Optional[List[AccountResponse]] = Field(
@@ -44,6 +48,8 @@ class TeamResponse(BaseModel):
description="A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.",
)
__properties: ClassVar[List[str]] = [
+ "team_id",
+ "parent_team_id",
"name",
"accounts",
"invited_accounts",
@@ -127,6 +133,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
_obj = cls.model_validate(
{
+ "team_id": obj.get("team_id"),
+ "parent_team_id": obj.get("parent_team_id"),
"name": obj.get("name"),
"accounts": (
[AccountResponse.from_dict(_item) for _item in obj["accounts"]]
@@ -159,6 +167,8 @@ def init(cls, data: Any) -> Self:
@classmethod
def openapi_types(cls) -> Dict[str, str]:
return {
+ "team_id": "(str,)",
+ "parent_team_id": "(str,)",
"name": "(str,)",
"accounts": "(List[AccountResponse],)",
"invited_accounts": "(List[AccountResponse],)",
diff --git a/sdks/ruby/docs/SubBulkSignerList.md b/sdks/ruby/docs/SubBulkSignerList.md
index 8bc4c101c..db1ac1fae 100644
--- a/sdks/ruby/docs/SubBulkSignerList.md
+++ b/sdks/ruby/docs/SubBulkSignerList.md
@@ -8,4 +8,5 @@
| ---- | ---- | ----------- | ----- |
| `custom_fields` | [```Array```](SubBulkSignerListCustomField.md) | An array of custom field values. | |
| `signers` | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
Currently only templates with a single role are supported. All signers must have the same `role` value. | |
+| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
diff --git a/sdks/ruby/docs/TeamCreateRequest.md b/sdks/ruby/docs/TeamCreateRequest.md
index 739b81f65..4d824845f 100644
--- a/sdks/ruby/docs/TeamCreateRequest.md
+++ b/sdks/ruby/docs/TeamCreateRequest.md
@@ -7,4 +7,5 @@
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `name` | ```String``` | The name of your Team. | [default to 'Untitled Team'] |
+| `parent_team_id` | ```String``` | The id of the parent team. Set this to create the new team as a sub-team of that parent. | |
diff --git a/sdks/ruby/docs/TeamResponse.md b/sdks/ruby/docs/TeamResponse.md
index b7b847604..86e89e619 100644
--- a/sdks/ruby/docs/TeamResponse.md
+++ b/sdks/ruby/docs/TeamResponse.md
@@ -6,6 +6,8 @@ Contains information about your team and its members
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
+| `team_id` | ```String``` | The id of a team | |
+| `parent_team_id` | ```String``` | The id of this team's parent team. | |
| `name` | ```String``` | The name of your Team | |
| `accounts` | [```Array```](AccountResponse.md) | | |
| `invited_accounts` | [```Array```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | |
diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb
index d3f3e4b76..c40cc9cb5 100644
--- a/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb
+++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb
@@ -259,6 +259,10 @@ def list_invalid_properties
invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.')
end
+ if !@metadata.nil? && @metadata.length > 10
+ invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 10.')
+ end
+
if !@subject.nil? && @subject.to_s.length > 255
invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.')
end
@@ -276,6 +280,7 @@ def valid?
return false if @template_ids.nil?
return false if @client_id.nil?
return false if !@message.nil? && @message.to_s.length > 5000
+ return false if !@metadata.nil? && @metadata.length > 10
return false if !@subject.nil? && @subject.to_s.length > 255
return false if !@title.nil? && @title.to_s.length > 255
true
@@ -314,6 +319,10 @@ def message=(message)
# Custom attribute writer method with validation
# @param [Object] metadata Value to be assigned
def metadata=(metadata)
+ if metadata.length > 10
+ fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 10.'
+ end
+
@metadata = metadata
end
diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb
index b4d9c432e..55edc3afb 100644
--- a/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb
+++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb
@@ -255,6 +255,10 @@ def list_invalid_properties
invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.')
end
+ if !@metadata.nil? && @metadata.length > 10
+ invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 10.')
+ end
+
if !@subject.nil? && @subject.to_s.length > 255
invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.')
end
@@ -271,6 +275,7 @@ def list_invalid_properties
def valid?
return false if @template_ids.nil?
return false if !@message.nil? && @message.to_s.length > 5000
+ return false if !@metadata.nil? && @metadata.length > 10
return false if !@subject.nil? && @subject.to_s.length > 255
return false if !@title.nil? && @title.to_s.length > 255
true
@@ -299,6 +304,10 @@ def message=(message)
# Custom attribute writer method with validation
# @param [Object] metadata Value to be assigned
def metadata=(metadata)
+ if metadata.length > 10
+ fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 10.'
+ end
+
@metadata = metadata
end
diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_bulk_signer_list.rb b/sdks/ruby/lib/dropbox-sign/models/sub_bulk_signer_list.rb
index 80085f38d..4684784aa 100644
--- a/sdks/ruby/lib/dropbox-sign/models/sub_bulk_signer_list.rb
+++ b/sdks/ruby/lib/dropbox-sign/models/sub_bulk_signer_list.rb
@@ -26,11 +26,16 @@ class SubBulkSignerList
# @return [Array]
attr_accessor :signers
+ # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+ # @return [Hash]
+ attr_accessor :metadata
+
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
:'custom_fields' => :'custom_fields',
- :'signers' => :'signers'
+ :'signers' => :'signers',
+ :'metadata' => :'metadata'
}
end
@@ -48,7 +53,8 @@ def self.acceptable_attributes
def self.openapi_types
{
:'custom_fields' => :'Array',
- :'signers' => :'Array'
+ :'signers' => :'Array',
+ :'metadata' => :'Hash'
}
end
@@ -110,28 +116,50 @@ def initialize(attributes = {})
self.signers = value
end
end
+
+ if attributes.key?(:'metadata')
+ if (value = attributes[:'metadata']).is_a?(Hash)
+ self.metadata = value
+ end
+ end
end
# Show invalid properties with the reasons. Usually used together with valid?
# @return Array for valid properties with the reasons
def list_invalid_properties
invalid_properties = Array.new
+ if !@metadata.nil? && @metadata.length > 10
+ invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 10.')
+ end
+
invalid_properties
end
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
def valid?
+ return false if !@metadata.nil? && @metadata.length > 10
true
end
+ # Custom attribute writer method with validation
+ # @param [Object] metadata Value to be assigned
+ def metadata=(metadata)
+ if metadata.length > 10
+ fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 10.'
+ end
+
+ @metadata = metadata
+ end
+
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
def ==(o)
return true if self.equal?(o)
self.class == o.class &&
custom_fields == o.custom_fields &&
- signers == o.signers
+ signers == o.signers &&
+ metadata == o.metadata
end
# @see the `==` method
@@ -143,7 +171,7 @@ def eql?(o)
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
- [custom_fields, signers].hash
+ [custom_fields, signers, metadata].hash
end
# Builds the object from hash
diff --git a/sdks/ruby/lib/dropbox-sign/models/team_create_request.rb b/sdks/ruby/lib/dropbox-sign/models/team_create_request.rb
index 3c1e69f5b..bf46491ed 100644
--- a/sdks/ruby/lib/dropbox-sign/models/team_create_request.rb
+++ b/sdks/ruby/lib/dropbox-sign/models/team_create_request.rb
@@ -22,10 +22,15 @@ class TeamCreateRequest
# @return [String]
attr_accessor :name
+ # The id of the parent team. Set this to create the new team as a sub-team of that parent.
+ # @return [String]
+ attr_accessor :parent_team_id
+
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
- :'name' => :'name'
+ :'name' => :'name',
+ :'parent_team_id' => :'parent_team_id'
}
end
@@ -42,7 +47,8 @@ def self.acceptable_attributes
# Attribute type mapping.
def self.openapi_types
{
- :'name' => :'String'
+ :'name' => :'String',
+ :'parent_team_id' => :'String'
}
end
@@ -98,6 +104,10 @@ def initialize(attributes = {})
else
self.name = 'Untitled Team'
end
+
+ if attributes.key?(:'parent_team_id')
+ self.parent_team_id = attributes[:'parent_team_id']
+ end
end
# Show invalid properties with the reasons. Usually used together with valid?
@@ -118,7 +128,8 @@ def valid?
def ==(o)
return true if self.equal?(o)
self.class == o.class &&
- name == o.name
+ name == o.name &&
+ parent_team_id == o.parent_team_id
end
# @see the `==` method
@@ -130,7 +141,7 @@ def eql?(o)
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
- [name].hash
+ [name, parent_team_id].hash
end
# Builds the object from hash
diff --git a/sdks/ruby/lib/dropbox-sign/models/team_response.rb b/sdks/ruby/lib/dropbox-sign/models/team_response.rb
index c239735dd..704b40107 100644
--- a/sdks/ruby/lib/dropbox-sign/models/team_response.rb
+++ b/sdks/ruby/lib/dropbox-sign/models/team_response.rb
@@ -19,6 +19,14 @@ module Dropbox
module Dropbox::Sign
# Contains information about your team and its members
class TeamResponse
+ # The id of a team
+ # @return [String]
+ attr_accessor :team_id
+
+ # The id of this team's parent team.
+ # @return [String]
+ attr_accessor :parent_team_id
+
# The name of your Team
# @return [String]
attr_accessor :name
@@ -37,6 +45,8 @@ class TeamResponse
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
+ :'team_id' => :'team_id',
+ :'parent_team_id' => :'parent_team_id',
:'name' => :'name',
:'accounts' => :'accounts',
:'invited_accounts' => :'invited_accounts',
@@ -57,6 +67,8 @@ def self.acceptable_attributes
# Attribute type mapping.
def self.openapi_types
{
+ :'team_id' => :'String',
+ :'parent_team_id' => :'String',
:'name' => :'String',
:'accounts' => :'Array',
:'invited_accounts' => :'Array',
@@ -111,6 +123,14 @@ def initialize(attributes = {})
h[k.to_sym] = v
}
+ if attributes.key?(:'team_id')
+ self.team_id = attributes[:'team_id']
+ end
+
+ if attributes.key?(:'parent_team_id')
+ self.parent_team_id = attributes[:'parent_team_id']
+ end
+
if attributes.key?(:'name')
self.name = attributes[:'name']
end
@@ -152,6 +172,8 @@ def valid?
def ==(o)
return true if self.equal?(o)
self.class == o.class &&
+ team_id == o.team_id &&
+ parent_team_id == o.parent_team_id &&
name == o.name &&
accounts == o.accounts &&
invited_accounts == o.invited_accounts &&
@@ -167,7 +189,7 @@ def eql?(o)
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
- [name, accounts, invited_accounts, invited_emails].hash
+ [team_id, parent_team_id, name, accounts, invited_accounts, invited_emails].hash
end
# Builds the object from hash
diff --git a/translations/en.yaml b/translations/en.yaml
index 866334d59..fefbb6fd2 100644
--- a/translations/en.yaml
+++ b/translations/en.yaml
@@ -267,6 +267,10 @@
"SignatureRequestBulkCreateEmbeddedWithTemplate::CLIENT_ID": Client id of the app you're using to create this embedded signature request. Used for security purposes.
"SignatureRequestBulkCreateEmbeddedWithTemplate::EXPIRES_AT": When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
"SignatureRequestBulkCreateEmbeddedWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
+"SignatureRequestBulkCreateEmbeddedWithTemplate::METADATA": |-
+ Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
+
+ Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
"SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNER_FILE": |-
`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
@@ -304,6 +308,10 @@
"SignatureRequestBulkSendWithTemplate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
"SignatureRequestBulkSendWithTemplate::EXPIRES_AT": When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
"SignatureRequestBulkSendWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
+"SignatureRequestBulkSendWithTemplate::METADATA": |-
+ Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
+
+ Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
"SignatureRequestBulkSendWithTemplate::SIGNER_FILE": |-
`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
@@ -610,6 +618,7 @@
"TeamCreate::SUMMARY": Create Team
"TeamCreate::DESCRIPTION": Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.
"TeamCreate::NAME": The name of your Team.
+"TeamCreate::PARENT_TEAM_ID": The id of the parent team. Set this to create the new team as a sub-team of that parent.
"TeamDelete::SUMMARY": Delete Team
"TeamDelete::DESCRIPTION": Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).
@@ -1012,6 +1021,10 @@
Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
Currently only templates with a single role are supported. All signers must have the same `role` value.
+"Sub::BulkSigner::METADATA": |-
+ Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
+
+ Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
"Sub::CC::DESCRIPTION": Add CC email recipients. Required when a CC role exists for the Template.
"Sub::CC::EMAIL_ADDRESS": The email address of the CC recipient.
@@ -1387,6 +1400,8 @@
"Common::RateLimiting::LIMIT": The maximum number of requests per hour that you can make.
"Common::RateLimiting::REMAINING": The number of requests remaining in the current rate limit window.
"Common::RateLimiting::RESET": The Unix time at which the rate limit will reset to its maximum.
+"Common::Idempotency::KEY": Optional header on an authenticated POST or PUT. Reuse the same key when retrying the same request. See [Idempotency](/api/manual-reference-pages/idempotency) for details.
+"Common::Idempotency::REPLAYED": Sent when the request included an Idempotency-Key. True when replaying a stored response, false otherwise. See [Idempotency](/api/manual-reference-pages/idempotency) for details.
"EmbeddedEditUrlResponseExample::SUMMARY": Embedded Edit URL
"EmbeddedSignUrlResponseExample::SUMMARY": Embedded Sign URL
@@ -1688,6 +1703,7 @@
"TeamUpdateResponseExample::SUMMARY": Team Update
"TeamDoesNotExistResponseExample::SUMMARY": Team Does Not Exist
"Team::NAME": The name of your Team
+"Team::PARENT_TEAM_ID": The id of this team's parent team.
"Team::INVITED_ACCOUNTS": A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`.
"Team::INVITED_EMAILS": A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.
"TeamGeneral::TEAM_ID": The id of a team
@@ -2070,8 +2086,8 @@
"ErrorCatalog::not_found::REMEDIATION": "Verify the id and that the resource belongs to the authenticated account."
"ErrorCatalog::conflict::SUMMARY": "The request was well-formed but conflicts with the current state."
-"ErrorCatalog::conflict::CAUSE": "The target resource is in a state incompatible with the request (e.g. a signature request is still being set up)."
-"ErrorCatalog::conflict::REMEDIATION": "Wait briefly and retry, or listen for a callback event confirming the resource is ready."
+"ErrorCatalog::conflict::CAUSE": "The target resource is in a state incompatible with the request (e.g. a signature request is still being set up). A POST or PUT can also return this status when an Idempotency-Key header is reused with different parameters, or while the original request is still in progress."
+"ErrorCatalog::conflict::REMEDIATION": "Wait briefly and retry, or listen for a callback event confirming the resource is ready. To make a POST or PUT safe to retry, send the same Idempotency-Key header (1 to 255 characters) with the other headers for that request. The same key and request within 24 hours returns the original response, with Idempotent-Replayed: true. Use a new key for a different request."
"ErrorCatalog::exceeded_rate::SUMMARY": "Your account's API request rate limit has been exceeded."
"ErrorCatalog::exceeded_rate::CAUSE": "Too many requests were sent within the rate-limit window for this request type."