CreateUserAgreementRequest

pydantic model openapi_client.models.create_user_agreement_request.CreateUserAgreementRequest

POST /user-agreements body. Exactly these three keys. Extra keys IPV-1008.

Fields:
field agreement_name: StrictStr [Required] (alias 'AgreementName')

Required non-empty. validate_name User Agreement: ^[a-zA-Z][a-zA-Z0-9_]{2,119}$ length 3-120. Duplicate case-insensitive name IPV-1018.

Constraints:

  • strict = True

field description: StrictStr [Required] (alias 'Description')

Key required. Empty string is allowed and stored as empty.

Constraints:

  • strict = True

field terms_of_use: StrictStr [Required] (alias 'TermsOfUse')

Required non-empty base64 markdown. Decode and S3 upload failures are HTTP 500 RTE-1001.

Constraints:

  • strict = True

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of CreateUserAgreementRequest from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of CreateUserAgreementRequest from a dict

Return type:

Optional[Self]