payrix-api-sdk 1.0.0

data/lib/payrix/models/invoice_result_post_request.rb

@@ -0,0 +1,416 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # InvoiceResultPostRequest Model.
+  class InvoiceResultPostRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier of the Invoice that owns this invoiceResults resource.
+    # @return [String]
+    attr_accessor :invoice
+
+    # The identifier of the Transaction associated with this invoiceResults
+    # resource.
+    # @return [String]
+    attr_accessor :txn
+
+    # The status of this invoiceResult
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `success` - **Successfuly processed.** 
+    # - `failure` - **Failed to process.**
+    # </details>
+    # @return [InvoiceResultStatusEnum]
+    attr_accessor :status
+
+    # A message that accompanies and describes this invoice result. This field
+    # is specified as a text string and must be between 1 and 500 characters
+    # long.
+    # @return [String]
+    attr_accessor :message
+
+    # The shipping first name associated with this InvoiceResult. This field is
+    # stored as a text string and must be between 0 and 100 characters long.
+    # @return [String]
+    attr_accessor :shipping_first
+
+    # The shipping middle name associated with this InvoiceResult. This field is
+    # stored as a text string and must be between 0 and 100 characters long.
+    # @return [String]
+    attr_accessor :shipping_middle
+
+    # The shipping last name associated with this InvoiceResult. This field is
+    # stored as a text string and must be between 0 and 100 characters long.
+    # @return [String]
+    attr_accessor :shipping_last
+
+    # The shipping name of the company associated with this InvoiceResult. This
+    # field is stored as a text string and must be between 0 and 100 characters
+    # long.
+    # @return [String]
+    attr_accessor :shipping_company
+
+    # The shipping first line of the address associated with this InvoiceResult.
+    # This field is stored as a text string and must be between 0 and 500
+    # characters long.
+    # @return [String]
+    attr_accessor :shipping_address1
+
+    # The shipping second line of the address associated with this
+    # InvoiceResult. This field is stored as a text string and must be between 0
+    # and 500 characters long.
+    # @return [String]
+    attr_accessor :shipping_address2
+
+    # The shipping name of the city in the address associated with this
+    # InvoiceResult. This field is stored as a text string and must be between 0
+    # and 500 characters long.
+    # @return [String]
+    attr_accessor :shipping_city
+
+    # The U.S. state or Canadian province relevant to the address provided here.
+    # If the location is within the U.S. and Canada, specify the 2-character
+    # postal abbreviation for the state. If the location is outside of the U.S.
+    # and Canada, provide the full state name. This field is stored as a text
+    # string and must be between 2 and 100 characters long.
+    #  
+    # <details>
+    # <summary>U.S. States</summary>
+    #  
+    #  - `AK` - **Alaska (US)**
+    #  
+    #  - `AR` - **Arkansas (US)**
+    #  
+    #  - `AL` - **Alabama (US)**
+    #  
+    #  - `AZ` - **Arizona (US)**
+    #  
+    #  - `CA` - **California (US)**
+    #  
+    #  - `CO` - **Colorado (US)**
+    #  
+    #  - `CT` - **Connecticut (US)**
+    #  
+    #  - `DE` - **Delaware (US)**
+    #  
+    #  - `FL` - **Florida (US)**
+    #  
+    #  - `GA` - **Georgia (US)**
+    #  
+    #  - `HI` - **Hawaii (US)**
+    #  
+    #  - `IA` - **Iowa (US)**
+    #  
+    #  - `ID` - **Idaho (US)**
+    #  
+    #  - `IL` - **Illinois (US)**
+    #  
+    #  - `IN` - **Indiana (US)**
+    #  
+    #  - `KY` - **Kentucky (US)**
+    #  
+    #  - `KS` - **Kansas (US)**
+    #  
+    #  - `LA` - **Louisiana (US)**
+    #  
+    #  - `MA` - **Massachusetts (US)**
+    #  
+    #  - `MD` - **Maryland (US)**
+    #  
+    #  - `ME` - **Maine (US)**
+    #  
+    #  - `MI` - **Michigan (US)**
+    #  
+    #  - `MN` - **Minnesota (US)**
+    #  
+    #  - `MO` - **Missouri (US)**
+    #  
+    #  - `MS` - **Mississippi (US)**
+    #  
+    #  - `MT` - **Montana (US)**
+    #  
+    #  - `NC` - **North Carolina (US)**
+    #  
+    #  - `ND` - **North Dakota (US)**
+    #  
+    #  - `NE` - **Nebraska (US)**
+    #  
+    #  - `NH` - **New Hampshire (US)**
+    #  
+    #  - `NJ` - **New Jersey (US)**
+    #  
+    #  - `NM` - **New Mexico (US)**
+    #  
+    #  - `NV` - **Nevada (US)**
+    #  
+    #  - `NY` - **New York (US)**
+    #  
+    #  - `OH` - **Ohio (US)**
+    #  
+    #  - `OK`- **Oklahoma (US)**
+    #  
+    #  - `OR` - **Oregon (US)**
+    #  
+    #  - `PA` - **Pennsylvania (US)**
+    #  
+    #  - `RI` - **Rhode Island (US)**
+    #  
+    #  - `SC`- **South Carolina (US)**
+    #  
+    #  - `SD` - **South Dakota (US)**
+    #  
+    #  - `TN` - **Tennessee (US)**
+    #  
+    #  - `TX` - **Texas (US)**
+    #  
+    #  - `UT` - **Utah (US)**
+    #  
+    #  - `VA` - **Virginia (US)**
+    #  
+    #  - `VT` - **Vermont (US)**
+    #  
+    #  - `WA` - **Washington (US)**
+    #  
+    #  - `WI` - **Wisconsin (US)**
+    #  
+    #  - `WV` - **West Virginia (US)**
+    #  
+    #  - `WY` - **Wyoming (US)**
+    #  </details>
+    #  <details>
+    # <summary>Canada Provinces and Territories</summary>
+    #  
+    #  - `AB` - **Alberta (CAN)**
+    #  
+    #  - `BC` - **British Columbia (CAN)**
+    #  
+    #  - `MB` - **Manitoba (CAN)**
+    #  
+    #  - `ON` - **Ontario (CAN)**
+    #  
+    #  - `NS` - **Nova Scotia (CAN)**
+    #  
+    #  - `NB` - **New Brunswick (CAN)**
+    #  
+    #  - `NL` - **Newfoundland and Labrador (CAN)**
+    #  
+    #  - `NT` - **Northwest Territories (CAN)**
+    #  
+    #  - `NU` - **Nunavut (CAN)**
+    #  
+    #  - `PE` - **Prince Edward Island (CAN)**
+    #  
+    #  - `QC` - **Quebec (CAN)**
+    #  
+    #  - `SK` - **Saskatchewan (CAN)**
+    #  
+    #  - `YT` - **Yukon (CAN)**
+    #  </details>
+    # @return [String]
+    attr_accessor :shipping_state
+
+    # The shipping zip code in the address associated with this InvoiceResult.
+    # This field is stored as a text string and must be between 1 and 20
+    # characters long.
+    # @return [String]
+    attr_accessor :shipping_zip
+
+    # The shipping country associated with this InvoiceResult, valid values
+    # being the 3-letter ISO code for the country.
+    # @return [ShippingCountryEnum]
+    attr_accessor :shipping_country
+
+    # The shipping phone number associated with this InvoiceResult. This field
+    # is stored as a text string and must be between 5 and 15 characters long.
+    # @return [String]
+    attr_accessor :shipping_phone
+
+    # The shipping fax number associated with this InvoiceResult, stored as a
+    # text string and must be between 5 and 15 characters long.
+    # @return [String]
+    attr_accessor :shipping_fax
+
+    # The authorization text the customer agreed to when making this payment.
+    # @return [String]
+    attr_accessor :authorization
+
+    # Replacement data for replaceable strings in the authorization text.
+    # @return [String]
+    attr_accessor :authorization_data
+
+    # The signature on file for the customer’s authorization acceptance.
+    # @return [String]
+    attr_accessor :signature
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice'] = 'invoice'
+      @_hash['txn'] = 'txn'
+      @_hash['status'] = 'status'
+      @_hash['message'] = 'message'
+      @_hash['shipping_first'] = 'shippingFirst'
+      @_hash['shipping_middle'] = 'shippingMiddle'
+      @_hash['shipping_last'] = 'shippingLast'
+      @_hash['shipping_company'] = 'shippingCompany'
+      @_hash['shipping_address1'] = 'shippingAddress1'
+      @_hash['shipping_address2'] = 'shippingAddress2'
+      @_hash['shipping_city'] = 'shippingCity'
+      @_hash['shipping_state'] = 'shippingState'
+      @_hash['shipping_zip'] = 'shippingZip'
+      @_hash['shipping_country'] = 'shippingCountry'
+      @_hash['shipping_phone'] = 'shippingPhone'
+      @_hash['shipping_fax'] = 'shippingFax'
+      @_hash['authorization'] = 'authorization'
+      @_hash['authorization_data'] = 'authorizationData'
+      @_hash['signature'] = 'signature'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        txn
+        status
+        message
+        shipping_first
+        shipping_middle
+        shipping_last
+        shipping_company
+        shipping_address1
+        shipping_address2
+        shipping_city
+        shipping_state
+        shipping_zip
+        shipping_country
+        shipping_phone
+        shipping_fax
+        authorization
+        authorization_data
+        signature
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        txn
+      ]
+    end
+
+    def initialize(invoice = nil, txn = SKIP, status = SKIP, message = SKIP,
+                   shipping_first = SKIP, shipping_middle = SKIP,
+                   shipping_last = SKIP, shipping_company = SKIP,
+                   shipping_address1 = SKIP, shipping_address2 = SKIP,
+                   shipping_city = SKIP, shipping_state = SKIP,
+                   shipping_zip = SKIP, shipping_country = SKIP,
+                   shipping_phone = SKIP, shipping_fax = SKIP,
+                   authorization = SKIP, authorization_data = SKIP,
+                   signature = SKIP)
+      @invoice = invoice
+      @txn = txn unless txn == SKIP
+      @status = status unless status == SKIP
+      @message = message unless message == SKIP
+      @shipping_first = shipping_first unless shipping_first == SKIP
+      @shipping_middle = shipping_middle unless shipping_middle == SKIP
+      @shipping_last = shipping_last unless shipping_last == SKIP
+      @shipping_company = shipping_company unless shipping_company == SKIP
+      @shipping_address1 = shipping_address1 unless shipping_address1 == SKIP
+      @shipping_address2 = shipping_address2 unless shipping_address2 == SKIP
+      @shipping_city = shipping_city unless shipping_city == SKIP
+      @shipping_state = shipping_state unless shipping_state == SKIP
+      @shipping_zip = shipping_zip unless shipping_zip == SKIP
+      @shipping_country = shipping_country unless shipping_country == SKIP
+      @shipping_phone = shipping_phone unless shipping_phone == SKIP
+      @shipping_fax = shipping_fax unless shipping_fax == SKIP
+      @authorization = authorization unless authorization == SKIP
+      @authorization_data = authorization_data unless authorization_data == SKIP
+      @signature = signature unless signature == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      invoice = hash.key?('invoice') ? hash['invoice'] : nil
+      txn = hash.key?('txn') ? hash['txn'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      shipping_first = hash.key?('shippingFirst') ? hash['shippingFirst'] : SKIP
+      shipping_middle =
+        hash.key?('shippingMiddle') ? hash['shippingMiddle'] : SKIP
+      shipping_last = hash.key?('shippingLast') ? hash['shippingLast'] : SKIP
+      shipping_company =
+        hash.key?('shippingCompany') ? hash['shippingCompany'] : SKIP
+      shipping_address1 =
+        hash.key?('shippingAddress1') ? hash['shippingAddress1'] : SKIP
+      shipping_address2 =
+        hash.key?('shippingAddress2') ? hash['shippingAddress2'] : SKIP
+      shipping_city = hash.key?('shippingCity') ? hash['shippingCity'] : SKIP
+      shipping_state = hash.key?('shippingState') ? hash['shippingState'] : SKIP
+      shipping_zip = hash.key?('shippingZip') ? hash['shippingZip'] : SKIP
+      shipping_country =
+        hash.key?('shippingCountry') ? hash['shippingCountry'] : SKIP
+      shipping_phone = hash.key?('shippingPhone') ? hash['shippingPhone'] : SKIP
+      shipping_fax = hash.key?('shippingFax') ? hash['shippingFax'] : SKIP
+      authorization = hash.key?('authorization') ? hash['authorization'] : SKIP
+      authorization_data =
+        hash.key?('authorizationData') ? hash['authorizationData'] : SKIP
+      signature = hash.key?('signature') ? hash['signature'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceResultPostRequest.new(invoice,
+                                   txn,
+                                   status,
+                                   message,
+                                   shipping_first,
+                                   shipping_middle,
+                                   shipping_last,
+                                   shipping_company,
+                                   shipping_address1,
+                                   shipping_address2,
+                                   shipping_city,
+                                   shipping_state,
+                                   shipping_zip,
+                                   shipping_country,
+                                   shipping_phone,
+                                   shipping_fax,
+                                   authorization,
+                                   authorization_data,
+                                   signature)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} invoice: #{@invoice}, txn: #{@txn}, status: #{@status}, message:"\
+      " #{@message}, shipping_first: #{@shipping_first}, shipping_middle: #{@shipping_middle},"\
+      " shipping_last: #{@shipping_last}, shipping_company: #{@shipping_company},"\
+      " shipping_address1: #{@shipping_address1}, shipping_address2: #{@shipping_address2},"\
+      " shipping_city: #{@shipping_city}, shipping_state: #{@shipping_state}, shipping_zip:"\
+      " #{@shipping_zip}, shipping_country: #{@shipping_country}, shipping_phone:"\
+      " #{@shipping_phone}, shipping_fax: #{@shipping_fax}, authorization: #{@authorization},"\
+      " authorization_data: #{@authorization_data}, signature: #{@signature}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} invoice: #{@invoice.inspect}, txn: #{@txn.inspect}, status:"\
+      " #{@status.inspect}, message: #{@message.inspect}, shipping_first:"\
+      " #{@shipping_first.inspect}, shipping_middle: #{@shipping_middle.inspect}, shipping_last:"\
+      " #{@shipping_last.inspect}, shipping_company: #{@shipping_company.inspect},"\
+      " shipping_address1: #{@shipping_address1.inspect}, shipping_address2:"\
+      " #{@shipping_address2.inspect}, shipping_city: #{@shipping_city.inspect}, shipping_state:"\
+      " #{@shipping_state.inspect}, shipping_zip: #{@shipping_zip.inspect}, shipping_country:"\
+      " #{@shipping_country.inspect}, shipping_phone: #{@shipping_phone.inspect}, shipping_fax:"\
+      " #{@shipping_fax.inspect}, authorization: #{@authorization.inspect}, authorization_data:"\
+      " #{@authorization_data.inspect}, signature: #{@signature.inspect}>"
+    end
+  end
+end