class

RightDocuments::ApiV1DocumentsDocumentIdDeliveriesPostRequestDelivery

Inherits JSON::Serializable < Reference < Object

Constructors

new(channel : String, provider : String | Nil, provider_id : String | Nil, tracking_url : String | Nil, status : String | Nil, sent_at : Time | Nil, delivered_at : Time | Nil, recipient_name : String | Nil, recipient_email : String | Nil, recipient_address : String | Nil, notes : String | Nil, party_id : String | Nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source
new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Class methods

build_from_hash(attributes)

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

Source

Instance methods

==(o)

Checks equality by comparing each attribute. @param [Object] Object to be compared

Source
_deserialize(type, value)

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

Source
_to_hash(value)

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

Source
build_from_hash(attributes)

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

Source
channel

Required properties

Source
channel=(channel : String)

Required properties

Source
channel=(channel : String)

Custom attribute writer method checking allowed values (enum). @param [Object] channel Object to be assigned

Source
delivered_at
Source
delivered_at=(delivered_at : Time | Nil)
Source
eql?(o)

@see the == method @param [Object] Object to be compared

Source
hash

Calculates hash code according to all attributes. @return [Integer] Hash code

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
notes
Source
notes=(notes : String | Nil)
Source
party_id

A party of the document's matter; fills the recipient

Source
party_id=(party_id : String | Nil)

A party of the document's matter; fills the recipient

Source
provider

Optional properties

Source
provider=(provider : String | Nil)

Optional properties

Source
provider=(provider : Nil | String)

Custom attribute writer method checking allowed values (enum). @param [Object] provider Object to be assigned

Source
provider_id
Source
provider_id=(provider_id : String | Nil)
Source
recipient_address
Source
recipient_address=(recipient_address : String | Nil)
Source
recipient_email
Source
recipient_email=(recipient_email : String | Nil)
Source
recipient_name
Source
recipient_name=(recipient_name : String | Nil)
Source
sent_at
Source
sent_at=(sent_at : Time | Nil)
Source
status
Source
status=(status : String | Nil)
Source
status=(status : Nil | String)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source
to_body

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

Source
to_hash

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

Source
to_s

Returns the string representation of the object @return [String] String presentation of the object

Source
tracking_url
Source
tracking_url=(tracking_url : String | Nil)
Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source

Nested types