Class: SwaggerClient::PurchaseContractRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/models/purchase_contract_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PurchaseContractRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



86
87
88
89
90
91
92
93
94
95
96
97
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
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 86

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'Test')
    self.test = attributes[:'Test']
  end

  if attributes.has_key?(:'LocationId')
    self.location_id = attributes[:'LocationId']
  end

  if attributes.has_key?(:'ClientId')
    self.client_id = attributes[:'ClientId']
  end

  if attributes.has_key?(:'ContractId')
    self.contract_id = attributes[:'ContractId']
  end

  if attributes.has_key?(:'StartDate')
    self.start_date = attributes[:'StartDate']
  end

  if attributes.has_key?(:'FirstPaymentOccurs')
    self.first_payment_occurs = attributes[:'FirstPaymentOccurs']
  end

  if attributes.has_key?(:'ClientSignature')
    self.client_signature = attributes[:'ClientSignature']
  end

  if attributes.has_key?(:'PromotionCode')
    self.promotion_code = attributes[:'PromotionCode']
  end

  if attributes.has_key?(:'CreditCardInfo')
    self.credit_card_info = attributes[:'CreditCardInfo']
  end

  if attributes.has_key?(:'StoredCardInfo')
    self.stored_card_info = attributes[:'StoredCardInfo']
  end

  if attributes.has_key?(:'SendNotifications')
    self.send_notifications = attributes[:'SendNotifications']
  end
end

Instance Attribute Details

#client_id ⇒ Object

The ID of the client. Note that this is not the same as the client’s unique ID.



24
25
26
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 24

def client_id
  @client_id
end

#client_signature ⇒ Object

A representation of the client’s signature. This value can take the form of Base64-encoded byte array. The file type should be PNG. The picture of the client’s signature is uploaded and viewable from the Client Documents page in the Core Business Mode software. The title of the document is:<br /> clientContractSignature-uniquePurchasedClientContractID-contractName-contractStartDate.fileType



36
37
38
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 36

def client_signature
  @client_signature
end

#contract_id ⇒ Object

The ID of the contract being purchased.



27
28
29
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 27

def contract_id
  @contract_id
end

#credit_card_info ⇒ Object

Contains credit card payment information.<br /> Either ‘StoredCardInfo` or `CreditCardInfo` is required; the other becomes optional.



42
43
44
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 42

def credit_card_info
  @credit_card_info
end

#first_payment_occurs ⇒ Object

The date on which the first payment is to occur. Possible values: * Instant * ‘StartDate`



33
34
35
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 33

def first_payment_occurs
  @first_payment_occurs
end

#location_id ⇒ Object

The ID of the location where the client is purchasing the contract; used for AutoPays.



21
22
23
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 21

def location_id
  @location_id
end

#promotion_code ⇒ Object

A promotion code, if one applies. Promotion codes are applied to items that are both marked as pay now in a contract and are discounted by the promotion code. If a pay now item is an autopay item, its autopay price is the price at the time of checkout, so, if a promotion code was applied, all autopays are scheduled using that discounted price.



39
40
41
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 39

def promotion_code
  @promotion_code
end

#send_notifications ⇒ Object

When ‘true`, indicates that email and SMS notifications should be sent to the client after purchase.<br /> Default: true



48
49
50
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 48

def send_notifications
  @send_notifications
end

#start_date ⇒ Object

The date that the contract starts.<br /> Default: **today’s date**



30
31
32
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 30

def start_date
  @start_date
end

#stored_card_info ⇒ Object

Contains information about the stored credit card payment.<br /> Either ‘CreditCardInfo` or `StoredCardInfo` is required; the other becomes optional.



45
46
47
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 45

def stored_card_info
  @stored_card_info
end

#test ⇒ Object

When ‘true`, the Public API validates input information, but does not commit it, so no client data is affected.<br /> When `false` or omitted, the transaction is committed, and client data is affected.<br /> Default: false



18
19
20
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 18

def test
  @test
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 51

def self.attribute_map
  {
    :'test' => :'Test',
    :'location_id' => :'LocationId',
    :'client_id' => :'ClientId',
    :'contract_id' => :'ContractId',
    :'start_date' => :'StartDate',
    :'first_payment_occurs' => :'FirstPaymentOccurs',
    :'client_signature' => :'ClientSignature',
    :'promotion_code' => :'PromotionCode',
    :'credit_card_info' => :'CreditCardInfo',
    :'stored_card_info' => :'StoredCardInfo',
    :'send_notifications' => :'SendNotifications'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 68

def self.swagger_types
  {
    :'test' => :'BOOLEAN',
    :'location_id' => :'Integer',
    :'client_id' => :'String',
    :'contract_id' => :'Integer',
    :'start_date' => :'DateTime',
    :'first_payment_occurs' => :'String',
    :'client_signature' => :'String',
    :'promotion_code' => :'String',
    :'credit_card_info' => :'CreditCardInfo',
    :'stored_card_info' => :'StoredCardInfo',
    :'send_notifications' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      test == o.test &&
      location_id == o.location_id &&
      client_id == o.client_id &&
      contract_id == o.contract_id &&
      start_date == o.start_date &&
      first_payment_occurs == o.first_payment_occurs &&
      client_signature == o.client_signature &&
      promotion_code == o.promotion_code &&
      credit_card_info == o.credit_card_info &&
      stored_card_info == o.stored_card_info &&
      send_notifications == o.send_notifications
end

#_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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 229

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = SwaggerClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 295

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

#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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


195
196
197
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



201
202
203
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 201

def hash
  [test, location_id, client_id, contract_id, start_date, first_payment_occurs, client_signature, promotion_code, credit_card_info, stored_card_info, send_notifications].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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 139

def list_invalid_properties
  invalid_properties = Array.new
  if @client_id.nil?
    invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
  end

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

  if !@client_signature.nil? && @client_signature !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
    invalid_properties.push('invalid value for "client_signature", must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.')
  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



275
276
277
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 275

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



281
282
283
284
285
286
287
288
289
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 281

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



269
270
271
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 269

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



158
159
160
161
162
163
 
# File 'lib/swagger_client/models/purchase_contract_request.rb', line 158

def valid?
  return false if @client_id.nil?
  return false if @contract_id.nil?
  return false if !@client_signature.nil? && @client_signature !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
  true
end