fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/v1_paylinks_request.rb

@@ -0,0 +1,380 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # V1PaylinksRequest Model.
+  class V1PaylinksRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location ID
+    # @return [String]
+    attr_accessor :location_id
+
+    # cc_product_transaction_id that has paylinks enabled in the service
+    # settings.
+    # @return [String]
+    attr_accessor :cc_product_transaction_id
+
+    # Optional. An email address that should be used as the "To" address when
+    # sending a Paylink Notification email.
+    # @return [String]
+    attr_accessor :email
+
+    # This is the amount that need to be paid (automatically calculated by
+    # system). amount_due= sum of items in item_list
+    # @return [Integer]
+    attr_accessor :amount_due
+
+    # Location Api Id. System id
+    # @return [String]
+    attr_accessor :location_api_id
+
+    # Include the Contact_id that the Paylink will belong to. This will allow
+    # you to query the List All Paylinks and filter_by Contact_id to see the
+    # status of all the contacts Paylinks.
+    # @return [String]
+    attr_accessor :contact_id
+
+    # Integrator provided unique id that was provided during the contact
+    # creation for the Fortis Contact. Include the Contact_id that the Paylink
+    # will belong to. This will allow you to query the List All Paylinks and
+    # filter_by Contact_id to see the status of all the contacts Paylinks.
+    # @return [String]
+    attr_accessor :contact_api_id
+
+    # Integrator provided id that prevents duplicate Paylinke Api Id's per
+    # location.
+    # @return [String]
+    attr_accessor :paylink_api_id
+
+    # ACH product transaction on which Paylink is created. This field is
+    # optional and will default to default_ach product if not supplied at all.
+    # Either this or cc_product_transaction_id must be supplied. Changes are
+    # allowed on PUT if payments have not been made against Paylink.
+    # @return [String]
+    attr_accessor :ach_product_transaction_id
+
+    # Expire Date of Paylink. Optional
+    # @return [String]
+    attr_accessor :expire_date
+
+    # Display Product Transaction Receipt Details. Show the receipt details
+    # after the successful payment
+    # @return [TrueClass | FalseClass]
+    attr_accessor :display_product_transaction_receipt_details
+
+    # Display Billing Fields to show the billing field inputs in the paylink
+    # form
+    # @return [TrueClass | FalseClass]
+    attr_accessor :display_billing_fields
+
+    # Delivery Method
+    # >0 - Do not send, use the expand parameter of payment_url in the create
+    # paylink request to obtain the payment_url to embed into your messaging
+    # system.
+    # >
+    # >1 - Email. Will send an email to the provided address in the email field.
+    # >
+    # >2 - SMS. Text message the Paylink. Check with sales rep for cost.
+    # >
+    # >3 - Both
+    # >
+    # @return [DeliveryMethodEnum]
+    attr_accessor :delivery_method
+
+    # Required if delivery_method is set to 2[SMS], 3[Both email and sms], this
+    # will be the recipient of the SMS
+    # @return [String]
+    attr_accessor :cell_phone
+
+    # Add a Description for reporting purposes
+    # @return [String]
+    attr_accessor :description
+
+    # Store Token to create a token_id(account_vault_id) to be used for future
+    # payment types(CC Sale Tokenized, ACH Debit Tokenized)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :store_token
+
+    # Store Token Title can be used to set the name of the token, sucha John
+    # Smith
+    # @return [String]
+    attr_accessor :store_token_title
+
+    # the action that will be used by the form when making the payment possible
+    # values: sale, auth-only
+    # @return [PaylinkActionEnum]
+    attr_accessor :paylink_action
+
+    # Bank Funded Only Override
+    # @return [TrueClass | FalseClass]
+    attr_accessor :bank_funded_only_override
+
+    # Used to apply tags to a paylink.
+    # @return [Array[String]]
+    attr_accessor :tags
+
+    # Redirect URL Delay in seconds
+    # @return [Float]
+    attr_accessor :redirect_url_delay
+
+    # Redirect URL On Approved transactions
+    # @return [String]
+    attr_accessor :redirect_url_on_approve
+
+    # Redirect URL On Declined transactions
+    # @return [String]
+    attr_accessor :redirect_url_on_decline
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['location_id'] = 'location_id'
+      @_hash['cc_product_transaction_id'] = 'cc_product_transaction_id'
+      @_hash['email'] = 'email'
+      @_hash['amount_due'] = 'amount_due'
+      @_hash['location_api_id'] = 'location_api_id'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['contact_api_id'] = 'contact_api_id'
+      @_hash['paylink_api_id'] = 'paylink_api_id'
+      @_hash['ach_product_transaction_id'] = 'ach_product_transaction_id'
+      @_hash['expire_date'] = 'expire_date'
+      @_hash['display_product_transaction_receipt_details'] =
+        'display_product_transaction_receipt_details'
+      @_hash['display_billing_fields'] = 'display_billing_fields'
+      @_hash['delivery_method'] = 'delivery_method'
+      @_hash['cell_phone'] = 'cell_phone'
+      @_hash['description'] = 'description'
+      @_hash['store_token'] = 'store_token'
+      @_hash['store_token_title'] = 'store_token_title'
+      @_hash['paylink_action'] = 'paylink_action'
+      @_hash['bank_funded_only_override'] = 'bank_funded_only_override'
+      @_hash['tags'] = 'tags'
+      @_hash['redirect_url_delay'] = 'redirect_url_delay'
+      @_hash['redirect_url_on_approve'] = 'redirect_url_on_approve'
+      @_hash['redirect_url_on_decline'] = 'redirect_url_on_decline'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        location_id
+        cc_product_transaction_id
+        email
+        location_api_id
+        contact_id
+        contact_api_id
+        paylink_api_id
+        ach_product_transaction_id
+        expire_date
+        display_product_transaction_receipt_details
+        display_billing_fields
+        delivery_method
+        cell_phone
+        description
+        store_token
+        store_token_title
+        paylink_action
+        bank_funded_only_override
+        tags
+        redirect_url_delay
+        redirect_url_on_approve
+        redirect_url_on_decline
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        location_id
+        cc_product_transaction_id
+        email
+        location_api_id
+        contact_id
+        contact_api_id
+        paylink_api_id
+        ach_product_transaction_id
+        expire_date
+        delivery_method
+        cell_phone
+        description
+        store_token_title
+        paylink_action
+        tags
+        redirect_url_delay
+        redirect_url_on_approve
+        redirect_url_on_decline
+      ]
+    end
+
+    def initialize(amount_due = nil, location_id = SKIP,
+                   cc_product_transaction_id = SKIP, email = SKIP,
+                   location_api_id = SKIP, contact_id = SKIP,
+                   contact_api_id = SKIP, paylink_api_id = SKIP,
+                   ach_product_transaction_id = SKIP, expire_date = SKIP,
+                   display_product_transaction_receipt_details = SKIP,
+                   display_billing_fields = SKIP, delivery_method = SKIP,
+                   cell_phone = SKIP, description = SKIP, store_token = SKIP,
+                   store_token_title = SKIP, paylink_action = SKIP,
+                   bank_funded_only_override = SKIP, tags = SKIP,
+                   redirect_url_delay = 15, redirect_url_on_approve = SKIP,
+                   redirect_url_on_decline = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @location_id = location_id unless location_id == SKIP
+      unless cc_product_transaction_id == SKIP
+        @cc_product_transaction_id =
+          cc_product_transaction_id
+      end
+      @email = email unless email == SKIP
+      @amount_due = amount_due
+      @location_api_id = location_api_id unless location_api_id == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @contact_api_id = contact_api_id unless contact_api_id == SKIP
+      @paylink_api_id = paylink_api_id unless paylink_api_id == SKIP
+      unless ach_product_transaction_id == SKIP
+        @ach_product_transaction_id =
+          ach_product_transaction_id
+      end
+      @expire_date = expire_date unless expire_date == SKIP
+      unless display_product_transaction_receipt_details == SKIP
+        @display_product_transaction_receipt_details =
+          display_product_transaction_receipt_details
+      end
+      @display_billing_fields = display_billing_fields unless display_billing_fields == SKIP
+      @delivery_method = delivery_method unless delivery_method == SKIP
+      @cell_phone = cell_phone unless cell_phone == SKIP
+      @description = description unless description == SKIP
+      @store_token = store_token unless store_token == SKIP
+      @store_token_title = store_token_title unless store_token_title == SKIP
+      @paylink_action = paylink_action unless paylink_action == SKIP
+      unless bank_funded_only_override == SKIP
+        @bank_funded_only_override =
+          bank_funded_only_override
+      end
+      @tags = tags unless tags == SKIP
+      @redirect_url_delay = redirect_url_delay unless redirect_url_delay == SKIP
+      @redirect_url_on_approve = redirect_url_on_approve unless redirect_url_on_approve == SKIP
+      @redirect_url_on_decline = redirect_url_on_decline unless redirect_url_on_decline == 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.
+      amount_due = hash.key?('amount_due') ? hash['amount_due'] : nil
+      location_id = hash.key?('location_id') ? hash['location_id'] : SKIP
+      cc_product_transaction_id =
+        hash.key?('cc_product_transaction_id') ? hash['cc_product_transaction_id'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      location_api_id =
+        hash.key?('location_api_id') ? hash['location_api_id'] : SKIP
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+      contact_api_id =
+        hash.key?('contact_api_id') ? hash['contact_api_id'] : SKIP
+      paylink_api_id =
+        hash.key?('paylink_api_id') ? hash['paylink_api_id'] : SKIP
+      ach_product_transaction_id =
+        hash.key?('ach_product_transaction_id') ? hash['ach_product_transaction_id'] : SKIP
+      expire_date = hash.key?('expire_date') ? hash['expire_date'] : SKIP
+      display_product_transaction_receipt_details =
+        hash.key?('display_product_transaction_receipt_details') ? hash['display_product_transaction_receipt_details'] : SKIP
+      display_billing_fields =
+        hash.key?('display_billing_fields') ? hash['display_billing_fields'] : SKIP
+      delivery_method =
+        hash.key?('delivery_method') ? hash['delivery_method'] : SKIP
+      cell_phone = hash.key?('cell_phone') ? hash['cell_phone'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      store_token = hash.key?('store_token') ? hash['store_token'] : SKIP
+      store_token_title =
+        hash.key?('store_token_title') ? hash['store_token_title'] : SKIP
+      paylink_action =
+        hash.key?('paylink_action') ? hash['paylink_action'] : SKIP
+      bank_funded_only_override =
+        hash.key?('bank_funded_only_override') ? hash['bank_funded_only_override'] : SKIP
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      redirect_url_delay = hash['redirect_url_delay'] ||= 15
+      redirect_url_on_approve =
+        hash.key?('redirect_url_on_approve') ? hash['redirect_url_on_approve'] : SKIP
+      redirect_url_on_decline =
+        hash.key?('redirect_url_on_decline') ? hash['redirect_url_on_decline'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      V1PaylinksRequest.new(amount_due,
+                            location_id,
+                            cc_product_transaction_id,
+                            email,
+                            location_api_id,
+                            contact_id,
+                            contact_api_id,
+                            paylink_api_id,
+                            ach_product_transaction_id,
+                            expire_date,
+                            display_product_transaction_receipt_details,
+                            display_billing_fields,
+                            delivery_method,
+                            cell_phone,
+                            description,
+                            store_token,
+                            store_token_title,
+                            paylink_action,
+                            bank_funded_only_override,
+                            tags,
+                            redirect_url_delay,
+                            redirect_url_on_approve,
+                            redirect_url_on_decline,
+                            additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} location_id: #{@location_id}, cc_product_transaction_id:"\
+      " #{@cc_product_transaction_id}, email: #{@email}, amount_due: #{@amount_due},"\
+      " location_api_id: #{@location_api_id}, contact_id: #{@contact_id}, contact_api_id:"\
+      " #{@contact_api_id}, paylink_api_id: #{@paylink_api_id}, ach_product_transaction_id:"\
+      " #{@ach_product_transaction_id}, expire_date: #{@expire_date},"\
+      ' display_product_transaction_receipt_details:'\
+      " #{@display_product_transaction_receipt_details}, display_billing_fields:"\
+      " #{@display_billing_fields}, delivery_method: #{@delivery_method}, cell_phone:"\
+      " #{@cell_phone}, description: #{@description}, store_token: #{@store_token},"\
+      " store_token_title: #{@store_token_title}, paylink_action: #{@paylink_action},"\
+      " bank_funded_only_override: #{@bank_funded_only_override}, tags: #{@tags},"\
+      " redirect_url_delay: #{@redirect_url_delay}, redirect_url_on_approve:"\
+      " #{@redirect_url_on_approve}, redirect_url_on_decline: #{@redirect_url_on_decline},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} location_id: #{@location_id.inspect}, cc_product_transaction_id:"\
+      " #{@cc_product_transaction_id.inspect}, email: #{@email.inspect}, amount_due:"\
+      " #{@amount_due.inspect}, location_api_id: #{@location_api_id.inspect}, contact_id:"\
+      " #{@contact_id.inspect}, contact_api_id: #{@contact_api_id.inspect}, paylink_api_id:"\
+      " #{@paylink_api_id.inspect}, ach_product_transaction_id:"\
+      " #{@ach_product_transaction_id.inspect}, expire_date: #{@expire_date.inspect},"\
+      ' display_product_transaction_receipt_details:'\
+      " #{@display_product_transaction_receipt_details.inspect}, display_billing_fields:"\
+      " #{@display_billing_fields.inspect}, delivery_method: #{@delivery_method.inspect},"\
+      " cell_phone: #{@cell_phone.inspect}, description: #{@description.inspect}, store_token:"\
+      " #{@store_token.inspect}, store_token_title: #{@store_token_title.inspect}, paylink_action:"\
+      " #{@paylink_action.inspect}, bank_funded_only_override:"\
+      " #{@bank_funded_only_override.inspect}, tags: #{@tags.inspect}, redirect_url_delay:"\
+      " #{@redirect_url_delay.inspect}, redirect_url_on_approve:"\
+      " #{@redirect_url_on_approve.inspect}, redirect_url_on_decline:"\
+      " #{@redirect_url_on_decline.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end