Class: StorecoveApi::InvoiceSubmission
- Inherits:
-
Object
- Object
- StorecoveApi::InvoiceSubmission
- Defined in:
- lib/storecove/models/invoice_submission.rb
Overview
The invoice you want Storecove to process, with some meta-data.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#document ⇒ Object
The invoice in PDF form.
-
#document_url ⇒ Object
A URL to retrieve the PDF document via HTTP GET.
-
#invoice ⇒ Object
Returns the value of attribute invoice.
-
#invoice_recipient ⇒ Object
Returns the value of attribute invoice_recipient.
-
#legal_supplier_id ⇒ Object
If a supplierId has more than one legal entity to send invoices from, specify the legal entity here.
-
#mode ⇒ Object
The mode in which to run this invoice submission.
-
#shop_account_id ⇒ Object
For internal use only.
-
#supplier_id ⇒ Object
The supplier id, provided by Storecove.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ InvoiceSubmission
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ InvoiceSubmission
Initializes the object
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 |
# File 'lib/storecove/models/invoice_submission.rb', line 91 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?(:'mode') self.mode = attributes[:'mode'] end if attributes.has_key?(:'supplierId') self.supplier_id = attributes[:'supplierId'] end if attributes.has_key?(:'legalSupplierId') self.legal_supplier_id = attributes[:'legalSupplierId'] end if attributes.has_key?(:'shopAccountId') self.shop_account_id = attributes[:'shopAccountId'] end if attributes.has_key?(:'invoiceRecipient') self.invoice_recipient = attributes[:'invoiceRecipient'] end if attributes.has_key?(:'document') self.document = attributes[:'document'] end if attributes.has_key?(:'documentUrl') self.document_url = attributes[:'documentUrl'] end if attributes.has_key?(:'invoice') self.invoice = attributes[:'invoice'] end end |
Instance Attribute Details
#document ⇒ Object
The invoice in PDF form. The document should be base64 encoded and the enocded string length should not exceed 2MB (2097152 bytes).
32 33 34 |
# File 'lib/storecove/models/invoice_submission.rb', line 32 def document @document end |
#document_url ⇒ Object
A URL to retrieve the PDF document via HTTP GET. If the link expires, please allow at least 7 days of validity.
35 36 37 |
# File 'lib/storecove/models/invoice_submission.rb', line 35 def document_url @document_url end |
#invoice ⇒ Object
Returns the value of attribute invoice.
37 38 39 |
# File 'lib/storecove/models/invoice_submission.rb', line 37 def invoice @invoice end |
#invoice_recipient ⇒ Object
Returns the value of attribute invoice_recipient.
29 30 31 |
# File 'lib/storecove/models/invoice_submission.rb', line 29 def invoice_recipient @invoice_recipient end |
#legal_supplier_id ⇒ Object
If a supplierId has more than one legal entity to send invoices from, specify the legal entity here. If you have not received one or more legal entities, don’t supply this field.
24 25 26 |
# File 'lib/storecove/models/invoice_submission.rb', line 24 def legal_supplier_id @legal_supplier_id end |
#mode ⇒ Object
The mode in which to run this invoice submission.
18 19 20 |
# File 'lib/storecove/models/invoice_submission.rb', line 18 def mode @mode end |
#shop_account_id ⇒ Object
For internal use only
27 28 29 |
# File 'lib/storecove/models/invoice_submission.rb', line 27 def shop_account_id @shop_account_id end |
#supplier_id ⇒ Object
The supplier id, provided by Storecove.
21 22 23 |
# File 'lib/storecove/models/invoice_submission.rb', line 21 def supplier_id @supplier_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/storecove/models/invoice_submission.rb', line 62 def self.attribute_map { :'mode' => :'mode', :'supplier_id' => :'supplierId', :'legal_supplier_id' => :'legalSupplierId', :'shop_account_id' => :'shopAccountId', :'invoice_recipient' => :'invoiceRecipient', :'document' => :'document', :'document_url' => :'documentUrl', :'invoice' => :'invoice' } end |
.swagger_types ⇒ Object
Attribute type mapping.
76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/storecove/models/invoice_submission.rb', line 76 def self.swagger_types { :'mode' => :'String', :'supplier_id' => :'Integer', :'legal_supplier_id' => :'Integer', :'shop_account_id' => :'Integer', :'invoice_recipient' => :'InvoiceRecipient', :'document' => :'String', :'document_url' => :'String', :'invoice' => :'Invoice' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/storecove/models/invoice_submission.rb', line 189 def ==(o) return true if self.equal?(o) self.class == o.class && mode == o.mode && supplier_id == o.supplier_id && legal_supplier_id == o.legal_supplier_id && shop_account_id == o.shop_account_id && invoice_recipient == o.invoice_recipient && document == o.document && document_url == o.document_url && invoice == o.invoice end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 266 267 268 269 270 271 272 273 274 |
# File 'lib/storecove/models/invoice_submission.rb', line 238 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 = StorecoveApi.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
304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/storecove/models/invoice_submission.rb', line 304 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
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/storecove/models/invoice_submission.rb', line 217 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
204 205 206 |
# File 'lib/storecove/models/invoice_submission.rb', line 204 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
210 211 212 |
# File 'lib/storecove/models/invoice_submission.rb', line 210 def hash [mode, supplier_id, legal_supplier_id, shop_account_id, invoice_recipient, document, document_url, invoice].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/storecove/models/invoice_submission.rb', line 133 def list_invalid_properties invalid_properties = Array.new if @mode.nil? invalid_properties.push("invalid value for 'mode', mode cannot be nil.") end if @supplier_id.nil? invalid_properties.push("invalid value for 'supplier_id', supplier_id cannot be nil.") end if @invoice_recipient.nil? invalid_properties.push("invalid value for 'invoice_recipient', invoice_recipient cannot be nil.") end if !@document.nil? && @document.to_s.length < 5 invalid_properties.push("invalid value for 'document', the character length must be great than or equal to 5.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
284 285 286 |
# File 'lib/storecove/models/invoice_submission.rb', line 284 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
290 291 292 293 294 295 296 297 298 |
# File 'lib/storecove/models/invoice_submission.rb', line 290 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
278 279 280 |
# File 'lib/storecove/models/invoice_submission.rb', line 278 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
156 157 158 159 160 161 162 163 164 |
# File 'lib/storecove/models/invoice_submission.rb', line 156 def valid? return false if @mode.nil? mode_validator = EnumAttributeValidator.new('String', ["direct"]) return false unless mode_validator.valid?(@mode) return false if @supplier_id.nil? return false if @invoice_recipient.nil? return false if !@document.nil? && @document.to_s.length < 5 return true end |