fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/v1_recurrings_request1.rb

@@ -0,0 +1,377 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # V1RecurringsRequest1 Model.
+  class V1RecurringsRequest1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Next Run Date
+    # @return [String]
+    attr_accessor :next_run_date
+
+    # Token ID
+    # @return [String]
+    attr_accessor :account_vault_id
+
+    # Token ID
+    # @return [String]
+    attr_accessor :token_id
+
+    # Active
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # Description
+    # @return [String]
+    attr_accessor :description
+
+    # End date
+    # @return [String]
+    attr_accessor :end_date
+
+    # Installment Total Count
+    # @return [Integer]
+    attr_accessor :installment_total_count
+
+    # Interval
+    # @return [Integer]
+    attr_accessor :interval
+
+    # Interval Type
+    # @return [IntervalTypeEnum]
+    attr_accessor :interval_type
+
+    # Location ID
+    # @return [String]
+    attr_accessor :location_id
+
+    # Notification Days
+    # @return [Integer]
+    attr_accessor :notification_days
+
+    # Payment Method
+    # @return [PaymentMethod1Enum]
+    attr_accessor :payment_method
+
+    # Product Transaction ID
+    # @return [String]
+    attr_accessor :product_transaction_id
+
+    # Recurring ID
+    # @return [String]
+    attr_accessor :recurring_id
+
+    # Recurring Api ID
+    # @return [String]
+    attr_accessor :recurring_api_id
+
+    # Start date
+    # @return [String]
+    attr_accessor :start_date
+
+    # Status
+    # @return [StatusEnum]
+    attr_accessor :status
+
+    # Transaction amount
+    # @return [Integer]
+    attr_accessor :transaction_amount
+
+    # Terms Agree
+    # @return [TrueClass | FalseClass]
+    attr_accessor :terms_agree
+
+    # Terms Agree Ip
+    # @return [String]
+    attr_accessor :terms_agree_ip
+
+    # Custom field used for integrations
+    # @return [String]
+    attr_accessor :recurring_c1
+
+    # Custom field used for integrations
+    # @return [String]
+    attr_accessor :recurring_c2
+
+    # Custom field used for integrations
+    # @return [String]
+    attr_accessor :recurring_c3
+
+    # Send To Proc As Recur
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_to_proc_as_recur
+
+    # Tags
+    # @return [Array[String]]
+    attr_accessor :tags
+
+    # Retained Amount
+    # @return [Integer]
+    attr_accessor :secondary_amount
+
+    # Contact ID
+    # @return [String]
+    attr_accessor :contact_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['next_run_date'] = 'next_run_date'
+      @_hash['account_vault_id'] = 'account_vault_id'
+      @_hash['token_id'] = 'token_id'
+      @_hash['active'] = 'active'
+      @_hash['description'] = 'description'
+      @_hash['end_date'] = 'end_date'
+      @_hash['installment_total_count'] = 'installment_total_count'
+      @_hash['interval'] = 'interval'
+      @_hash['interval_type'] = 'interval_type'
+      @_hash['location_id'] = 'location_id'
+      @_hash['notification_days'] = 'notification_days'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['product_transaction_id'] = 'product_transaction_id'
+      @_hash['recurring_id'] = 'recurring_id'
+      @_hash['recurring_api_id'] = 'recurring_api_id'
+      @_hash['start_date'] = 'start_date'
+      @_hash['status'] = 'status'
+      @_hash['transaction_amount'] = 'transaction_amount'
+      @_hash['terms_agree'] = 'terms_agree'
+      @_hash['terms_agree_ip'] = 'terms_agree_ip'
+      @_hash['recurring_c1'] = 'recurring_c1'
+      @_hash['recurring_c2'] = 'recurring_c2'
+      @_hash['recurring_c3'] = 'recurring_c3'
+      @_hash['send_to_proc_as_recur'] = 'send_to_proc_as_recur'
+      @_hash['tags'] = 'tags'
+      @_hash['secondary_amount'] = 'secondary_amount'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_run_date
+        account_vault_id
+        token_id
+        active
+        description
+        end_date
+        installment_total_count
+        interval
+        interval_type
+        location_id
+        notification_days
+        payment_method
+        product_transaction_id
+        recurring_id
+        recurring_api_id
+        start_date
+        status
+        transaction_amount
+        terms_agree
+        terms_agree_ip
+        recurring_c1
+        recurring_c2
+        recurring_c3
+        send_to_proc_as_recur
+        tags
+        secondary_amount
+        contact_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        next_run_date
+        account_vault_id
+        token_id
+        description
+        end_date
+        installment_total_count
+        interval
+        interval_type
+        location_id
+        notification_days
+        payment_method
+        product_transaction_id
+        recurring_id
+        recurring_api_id
+        start_date
+        status
+        transaction_amount
+        terms_agree_ip
+        recurring_c1
+        recurring_c2
+        recurring_c3
+        tags
+        secondary_amount
+        contact_id
+      ]
+    end
+
+    def initialize(next_run_date = SKIP, account_vault_id = SKIP,
+                   token_id = SKIP, active = SKIP, description = SKIP,
+                   end_date = SKIP, installment_total_count = SKIP,
+                   interval = SKIP, interval_type = SKIP, location_id = SKIP,
+                   notification_days = SKIP, payment_method = SKIP,
+                   product_transaction_id = SKIP, recurring_id = SKIP,
+                   recurring_api_id = SKIP, start_date = SKIP, status = SKIP,
+                   transaction_amount = SKIP, terms_agree = SKIP,
+                   terms_agree_ip = SKIP, recurring_c1 = SKIP,
+                   recurring_c2 = SKIP, recurring_c3 = SKIP,
+                   send_to_proc_as_recur = SKIP, tags = SKIP,
+                   secondary_amount = SKIP, contact_id = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @next_run_date = next_run_date unless next_run_date == SKIP
+      @account_vault_id = account_vault_id unless account_vault_id == SKIP
+      @token_id = token_id unless token_id == SKIP
+      @active = active unless active == SKIP
+      @description = description unless description == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @installment_total_count = installment_total_count unless installment_total_count == SKIP
+      @interval = interval unless interval == SKIP
+      @interval_type = interval_type unless interval_type == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @notification_days = notification_days unless notification_days == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @product_transaction_id = product_transaction_id unless product_transaction_id == SKIP
+      @recurring_id = recurring_id unless recurring_id == SKIP
+      @recurring_api_id = recurring_api_id unless recurring_api_id == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @status = status unless status == SKIP
+      @transaction_amount = transaction_amount unless transaction_amount == SKIP
+      @terms_agree = terms_agree unless terms_agree == SKIP
+      @terms_agree_ip = terms_agree_ip unless terms_agree_ip == SKIP
+      @recurring_c1 = recurring_c1 unless recurring_c1 == SKIP
+      @recurring_c2 = recurring_c2 unless recurring_c2 == SKIP
+      @recurring_c3 = recurring_c3 unless recurring_c3 == SKIP
+      @send_to_proc_as_recur = send_to_proc_as_recur unless send_to_proc_as_recur == SKIP
+      @tags = tags unless tags == SKIP
+      @secondary_amount = secondary_amount unless secondary_amount == SKIP
+      @contact_id = contact_id unless contact_id == 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.
+      next_run_date = hash.key?('next_run_date') ? hash['next_run_date'] : SKIP
+      account_vault_id =
+        hash.key?('account_vault_id') ? hash['account_vault_id'] : SKIP
+      token_id = hash.key?('token_id') ? hash['token_id'] : SKIP
+      active = hash.key?('active') ? hash['active'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      installment_total_count =
+        hash.key?('installment_total_count') ? hash['installment_total_count'] : SKIP
+      interval = hash.key?('interval') ? hash['interval'] : SKIP
+      interval_type = hash.key?('interval_type') ? hash['interval_type'] : SKIP
+      location_id = hash.key?('location_id') ? hash['location_id'] : SKIP
+      notification_days =
+        hash.key?('notification_days') ? hash['notification_days'] : SKIP
+      payment_method =
+        hash.key?('payment_method') ? hash['payment_method'] : SKIP
+      product_transaction_id =
+        hash.key?('product_transaction_id') ? hash['product_transaction_id'] : SKIP
+      recurring_id = hash.key?('recurring_id') ? hash['recurring_id'] : SKIP
+      recurring_api_id =
+        hash.key?('recurring_api_id') ? hash['recurring_api_id'] : SKIP
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      transaction_amount =
+        hash.key?('transaction_amount') ? hash['transaction_amount'] : SKIP
+      terms_agree = hash.key?('terms_agree') ? hash['terms_agree'] : SKIP
+      terms_agree_ip =
+        hash.key?('terms_agree_ip') ? hash['terms_agree_ip'] : SKIP
+      recurring_c1 = hash.key?('recurring_c1') ? hash['recurring_c1'] : SKIP
+      recurring_c2 = hash.key?('recurring_c2') ? hash['recurring_c2'] : SKIP
+      recurring_c3 = hash.key?('recurring_c3') ? hash['recurring_c3'] : SKIP
+      send_to_proc_as_recur =
+        hash.key?('send_to_proc_as_recur') ? hash['send_to_proc_as_recur'] : SKIP
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      secondary_amount =
+        hash.key?('secondary_amount') ? hash['secondary_amount'] : SKIP
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      V1RecurringsRequest1.new(next_run_date,
+                               account_vault_id,
+                               token_id,
+                               active,
+                               description,
+                               end_date,
+                               installment_total_count,
+                               interval,
+                               interval_type,
+                               location_id,
+                               notification_days,
+                               payment_method,
+                               product_transaction_id,
+                               recurring_id,
+                               recurring_api_id,
+                               start_date,
+                               status,
+                               transaction_amount,
+                               terms_agree,
+                               terms_agree_ip,
+                               recurring_c1,
+                               recurring_c2,
+                               recurring_c3,
+                               send_to_proc_as_recur,
+                               tags,
+                               secondary_amount,
+                               contact_id,
+                               additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} next_run_date: #{@next_run_date}, account_vault_id: #{@account_vault_id},"\
+      " token_id: #{@token_id}, active: #{@active}, description: #{@description}, end_date:"\
+      " #{@end_date}, installment_total_count: #{@installment_total_count}, interval:"\
+      " #{@interval}, interval_type: #{@interval_type}, location_id: #{@location_id},"\
+      " notification_days: #{@notification_days}, payment_method: #{@payment_method},"\
+      " product_transaction_id: #{@product_transaction_id}, recurring_id: #{@recurring_id},"\
+      " recurring_api_id: #{@recurring_api_id}, start_date: #{@start_date}, status: #{@status},"\
+      " transaction_amount: #{@transaction_amount}, terms_agree: #{@terms_agree}, terms_agree_ip:"\
+      " #{@terms_agree_ip}, recurring_c1: #{@recurring_c1}, recurring_c2: #{@recurring_c2},"\
+      " recurring_c3: #{@recurring_c3}, send_to_proc_as_recur: #{@send_to_proc_as_recur}, tags:"\
+      " #{@tags}, secondary_amount: #{@secondary_amount}, contact_id: #{@contact_id},"\
+      " 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} next_run_date: #{@next_run_date.inspect}, account_vault_id:"\
+      " #{@account_vault_id.inspect}, token_id: #{@token_id.inspect}, active: #{@active.inspect},"\
+      " description: #{@description.inspect}, end_date: #{@end_date.inspect},"\
+      " installment_total_count: #{@installment_total_count.inspect}, interval:"\
+      " #{@interval.inspect}, interval_type: #{@interval_type.inspect}, location_id:"\
+      " #{@location_id.inspect}, notification_days: #{@notification_days.inspect}, payment_method:"\
+      " #{@payment_method.inspect}, product_transaction_id: #{@product_transaction_id.inspect},"\
+      " recurring_id: #{@recurring_id.inspect}, recurring_api_id: #{@recurring_api_id.inspect},"\
+      " start_date: #{@start_date.inspect}, status: #{@status.inspect}, transaction_amount:"\
+      " #{@transaction_amount.inspect}, terms_agree: #{@terms_agree.inspect}, terms_agree_ip:"\
+      " #{@terms_agree_ip.inspect}, recurring_c1: #{@recurring_c1.inspect}, recurring_c2:"\
+      " #{@recurring_c2.inspect}, recurring_c3: #{@recurring_c3.inspect}, send_to_proc_as_recur:"\
+      " #{@send_to_proc_as_recur.inspect}, tags: #{@tags.inspect}, secondary_amount:"\
+      " #{@secondary_amount.inspect}, contact_id: #{@contact_id.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/v1_recurrings_skip_payment_request.rb

@@ -0,0 +1,71 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # V1RecurringsSkipPaymentRequest Model.
+  class V1RecurringsSkipPaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Skip Count
+    # @return [Integer]
+    attr_accessor :skip_count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['skip_count'] = 'skip_count'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(skip_count = nil, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @skip_count = skip_count
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      skip_count = hash.key?('skip_count') ? hash['skip_count'] : nil
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      V1RecurringsSkipPaymentRequest.new(skip_count,
+                                         additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} skip_count: #{@skip_count}, 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} skip_count: #{@skip_count.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/v1_signatures_request.rb

@@ -0,0 +1,91 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # V1SignaturesRequest Model.
+  class V1SignaturesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Signature
+    # @return [String]
+    attr_accessor :signature
+
+    # Resource
+    # >Recurring, Transaction, AccountVault, DeviceTerm
+    # >
+    # @return [ResourceEnum]
+    attr_accessor :resource
+
+    # Resource ID
+    # @return [String]
+    attr_accessor :resource_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['signature'] = 'signature'
+      @_hash['resource'] = 'resource'
+      @_hash['resource_id'] = 'resource_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(signature = nil, resource = nil, resource_id = nil,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @signature = signature
+      @resource = resource
+      @resource_id = resource_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      signature = hash.key?('signature') ? hash['signature'] : nil
+      resource = hash.key?('resource') ? hash['resource'] : nil
+      resource_id = hash.key?('resource_id') ? hash['resource_id'] : nil
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      V1SignaturesRequest.new(signature,
+                              resource,
+                              resource_id,
+                              additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} signature: #{@signature}, resource: #{@resource}, resource_id:"\
+      " #{@resource_id}, 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} signature: #{@signature.inspect}, resource: #{@resource.inspect},"\
+      " resource_id: #{@resource_id.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/v1_tags_request.rb

@@ -0,0 +1,79 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # V1TagsRequest Model.
+  class V1TagsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location ID
+    # @return [String]
+    attr_accessor :location_id
+
+    # Tag Title
+    # @return [String]
+    attr_accessor :title
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['location_id'] = 'location_id'
+      @_hash['title'] = 'title'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(location_id = nil, title = nil, 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
+      @title = title
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      location_id = hash.key?('location_id') ? hash['location_id'] : nil
+      title = hash.key?('title') ? hash['title'] : nil
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      V1TagsRequest.new(location_id,
+                        title,
+                        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}, title: #{@title}, 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}, title: #{@title.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/v1_tags_request1.rb

@@ -0,0 +1,85 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # V1TagsRequest1 Model.
+  class V1TagsRequest1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location ID
+    # @return [String]
+    attr_accessor :location_id
+
+    # Tag Title
+    # @return [String]
+    attr_accessor :title
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['location_id'] = 'location_id'
+      @_hash['title'] = 'title'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        location_id
+        title
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        location_id
+        title
+      ]
+    end
+
+    def initialize(location_id = SKIP, title = 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
+      @title = title unless title == 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.
+      location_id = hash.key?('location_id') ? hash['location_id'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      V1TagsRequest1.new(location_id,
+                         title,
+                         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}, title: #{@title}, 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}, title: #{@title.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end