Class: SignWell::CreateBulkSendRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/signwell_sdk/models/create_bulk_send_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBulkSendRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 98

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SignWell::CreateBulkSendRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SignWell::CreateBulkSendRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'template_ids')
    if (value = attributes[:'template_ids']).is_a?(Array)
      self.template_ids = value
    end
  else
    self.template_ids = nil
  end

  if attributes.key?(:'bulk_send_csv')
    self.bulk_send_csv = attributes[:'bulk_send_csv']
  else
    self.bulk_send_csv = nil
  end

  if attributes.key?(:'skip_row_errors')
    self.skip_row_errors = attributes[:'skip_row_errors']
  else
    self.skip_row_errors = false
  end

  if attributes.key?(:'api_application_id')
    self.api_application_id = attributes[:'api_application_id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'subject')
    self.subject = attributes[:'subject']
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.key?(:'apply_signing_order')
    self.apply_signing_order = attributes[:'apply_signing_order']
  else
    self.apply_signing_order = false
  end

  if attributes.key?(:'custom_requester_name')
    self.custom_requester_name = attributes[:'custom_requester_name']
  end

  if attributes.key?(:'custom_requester_email')
    self.custom_requester_email = attributes[:'custom_requester_email']
  end
end

Instance Attribute Details

#api_application_id ⇒ Object

Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings



28
29
30
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 28

def api_application_id
  @api_application_id
end

#apply_signing_order ⇒ Object

When set to true recipients will sign one at a time in the order of the recipients collection of this request.



40
41
42
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 40

def apply_signing_order
  @apply_signing_order
end

#bulk_send_csv ⇒ Object

A RFC 4648 base64 string of the template CSV file to be validated.



22
23
24
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 22

def bulk_send_csv
  @bulk_send_csv
end

#custom_requester_email ⇒ Object

Sets the custom requester email for the document. When set, this is the email used for all email communications, signing notifications, and in the audit file.



46
47
48
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 46

def custom_requester_email
  @custom_requester_email
end

#custom_requester_name ⇒ Object

Sets the custom requester name for the document. When set, this is the name used for all email communications, signing notifications, and in the audit file.



43
44
45
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 43

def custom_requester_name
  @custom_requester_name
end

#message ⇒ Object

Email message for the signature request that recipients will see. Defaults to the default system message or a template message.



37
38
39
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 37

def message
  @message
end

#name ⇒ Object

The name of the Bulk Send. Will be used as the document name for each of the documents.



31
32
33
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 31

def name
  @name
end

#skip_row_errors ⇒ Object

Whether to skip errors in the rows. Defaults to false.



25
26
27
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 25

def skip_row_errors
  @skip_row_errors
end

#subject ⇒ Object

Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject.



34
35
36
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 34

def subject
  @subject
end

#template_ids ⇒ Object

Unique identifiers for a list of templates.



19
20
21
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 19

def template_ids
  @template_ids
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 264

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = SignWell.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



65
66
67
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 65

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 70

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 49

def self.attribute_map
  {
    :'template_ids' => :'template_ids',
    :'bulk_send_csv' => :'bulk_send_csv',
    :'skip_row_errors' => :'skip_row_errors',
    :'api_application_id' => :'api_application_id',
    :'name' => :'name',
    :'subject' => :'subject',
    :'message' => :'message',
    :'apply_signing_order' => :'apply_signing_order',
    :'custom_requester_name' => :'custom_requester_name',
    :'custom_requester_email' => :'custom_requester_email'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 240

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 91

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 75

def self.openapi_types
  {
    :'template_ids' => :'Array<String>',
    :'bulk_send_csv' => :'String',
    :'skip_row_errors' => :'Boolean',
    :'api_application_id' => :'String',
    :'name' => :'String',
    :'subject' => :'String',
    :'message' => :'String',
    :'apply_signing_order' => :'Boolean',
    :'custom_requester_name' => :'String',
    :'custom_requester_email' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      template_ids == o.template_ids &&
      bulk_send_csv == o.bulk_send_csv &&
      skip_row_errors == o.skip_row_errors &&
      api_application_id == o.api_application_id &&
      name == o.name &&
      subject == o.subject &&
      message == o.message &&
      apply_signing_order == o.apply_signing_order &&
      custom_requester_name == o.custom_requester_name &&
      custom_requester_email == o.custom_requester_email
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 335

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


227
228
229
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



233
234
235
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 233

def hash
  [template_ids, bulk_send_csv, skip_row_errors, api_application_id, name, subject, message, apply_signing_order, custom_requester_name, custom_requester_email].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 165

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @template_ids.nil?
    invalid_properties.push('invalid value for "template_ids", template_ids cannot be nil.')
  end

  if @bulk_send_csv.nil?
    invalid_properties.push('invalid value for "bulk_send_csv", bulk_send_csv cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



311
312
313
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 311

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 317

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



305
306
307
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 305

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



181
182
183
184
185
186
 
# File 'lib/signwell_sdk/models/create_bulk_send_request.rb', line 181

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @template_ids.nil?
  return false if @bulk_send_csv.nil?
  true
end