subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/override_subscription_request.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # OverrideSubscriptionRequest Model.
+  class OverrideSubscriptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [OverrideSubscription]
+    attr_accessor :subscription
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscription'] = 'subscription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscription = nil)
+      @subscription = subscription
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      subscription = OverrideSubscription.from_hash(hash['subscription']) if hash['subscription']
+
+      # Create object from extracted values.
+      OverrideSubscriptionRequest.new(subscription)
+    end
+  end
+end

data/lib/advanced_billing/models/paginated_metadata.rb

@@ -0,0 +1,96 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PaginatedMetadata Model.
+  class PaginatedMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :current_page
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :per_page
+
+    # TODO: Write general description for this method
+    # @return [Array[Metadata]]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_count'] = 'total_count'
+      @_hash['current_page'] = 'current_page'
+      @_hash['total_pages'] = 'total_pages'
+      @_hash['per_page'] = 'per_page'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_count
+        current_page
+        total_pages
+        per_page
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_count = SKIP, current_page = SKIP, total_pages = SKIP,
+                   per_page = SKIP, metadata = SKIP)
+      @total_count = total_count unless total_count == SKIP
+      @current_page = current_page unless current_page == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @per_page = per_page unless per_page == SKIP
+      @metadata = metadata unless metadata == 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.
+      total_count = hash.key?('total_count') ? hash['total_count'] : SKIP
+      current_page = hash.key?('current_page') ? hash['current_page'] : SKIP
+      total_pages = hash.key?('total_pages') ? hash['total_pages'] : SKIP
+      per_page = hash.key?('per_page') ? hash['per_page'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (Metadata.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = SKIP unless hash.key?('metadata')
+
+      # Create object from extracted values.
+      PaginatedMetadata.new(total_count,
+                            current_page,
+                            total_pages,
+                            per_page,
+                            metadata)
+    end
+  end
+end

data/lib/advanced_billing/models/pause_request.rb

@@ -0,0 +1,50 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Allows to pause a Subscription
+  class PauseRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AutoResume]
+    attr_accessor :hold
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['hold'] = 'hold'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        hold
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(hold = SKIP)
+      @hold = hold unless hold == 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.
+      hold = AutoResume.from_hash(hash['hold']) if hash['hold']
+
+      # Create object from extracted values.
+      PauseRequest.new(hold)
+    end
+  end
+end

data/lib/advanced_billing/models/payer_attributes.rb

@@ -0,0 +1,221 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PayerAttributes Model.
+  class PayerAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :first_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :last_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :email
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cc_emails
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :organization
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reference
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :address
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :address_2
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :city
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :state
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :zip
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :country
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :phone
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :locale
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :vat_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tax_exempt
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tax_exempt_reason
+
+    # (Optional) A set of key/value pairs representing custom fields and their
+    # values. Metafields will be created “on-the-fly” in your site for a given
+    # key, if they have not been created yet.
+    # @return [Hash[String, String]]
+    attr_accessor :metafields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['email'] = 'email'
+      @_hash['cc_emails'] = 'cc_emails'
+      @_hash['organization'] = 'organization'
+      @_hash['reference'] = 'reference'
+      @_hash['address'] = 'address'
+      @_hash['address_2'] = 'address_2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash['phone'] = 'phone'
+      @_hash['locale'] = 'locale'
+      @_hash['vat_number'] = 'vat_number'
+      @_hash['tax_exempt'] = 'tax_exempt'
+      @_hash['tax_exempt_reason'] = 'tax_exempt_reason'
+      @_hash['metafields'] = 'metafields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        email
+        cc_emails
+        organization
+        reference
+        address
+        address_2
+        city
+        state
+        zip
+        country
+        phone
+        locale
+        vat_number
+        tax_exempt
+        tax_exempt_reason
+        metafields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first_name = SKIP, last_name = SKIP, email = SKIP,
+                   cc_emails = SKIP, organization = SKIP, reference = SKIP,
+                   address = SKIP, address_2 = SKIP, city = SKIP, state = SKIP,
+                   zip = SKIP, country = SKIP, phone = SKIP, locale = SKIP,
+                   vat_number = SKIP, tax_exempt = SKIP,
+                   tax_exempt_reason = SKIP, metafields = SKIP)
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @email = email unless email == SKIP
+      @cc_emails = cc_emails unless cc_emails == SKIP
+      @organization = organization unless organization == SKIP
+      @reference = reference unless reference == SKIP
+      @address = address unless address == SKIP
+      @address_2 = address_2 unless address_2 == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @zip = zip unless zip == SKIP
+      @country = country unless country == SKIP
+      @phone = phone unless phone == SKIP
+      @locale = locale unless locale == SKIP
+      @vat_number = vat_number unless vat_number == SKIP
+      @tax_exempt = tax_exempt unless tax_exempt == SKIP
+      @tax_exempt_reason = tax_exempt_reason unless tax_exempt_reason == SKIP
+      @metafields = metafields unless metafields == 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.
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      cc_emails = hash.key?('cc_emails') ? hash['cc_emails'] : SKIP
+      organization = hash.key?('organization') ? hash['organization'] : SKIP
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      address = hash.key?('address') ? hash['address'] : SKIP
+      address_2 = hash.key?('address_2') ? hash['address_2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+      vat_number = hash.key?('vat_number') ? hash['vat_number'] : SKIP
+      tax_exempt = hash.key?('tax_exempt') ? hash['tax_exempt'] : SKIP
+      tax_exempt_reason =
+        hash.key?('tax_exempt_reason') ? hash['tax_exempt_reason'] : SKIP
+      metafields = hash.key?('metafields') ? hash['metafields'] : SKIP
+
+      # Create object from extracted values.
+      PayerAttributes.new(first_name,
+                          last_name,
+                          email,
+                          cc_emails,
+                          organization,
+                          reference,
+                          address,
+                          address_2,
+                          city,
+                          state,
+                          zip,
+                          country,
+                          phone,
+                          locale,
+                          vat_number,
+                          tax_exempt,
+                          tax_exempt_reason,
+                          metafields)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PayerAttributes | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end

data/lib/advanced_billing/models/payer_error.rb

@@ -0,0 +1,68 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PayerError Model.
+  class PayerError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :last_name
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :first_name
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['last_name'] = 'last_name'
+      @_hash['first_name'] = 'first_name'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        last_name
+        first_name
+        email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(last_name = SKIP, first_name = SKIP, email = SKIP)
+      @last_name = last_name unless last_name == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @email = email unless email == 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.
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+
+      # Create object from extracted values.
+      PayerError.new(last_name,
+                     first_name,
+                     email)
+    end
+  end
+end

data/lib/advanced_billing/models/payment.rb

@@ -0,0 +1,80 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Payment Model.
+  class Payment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The uid of the paid invoice
+    # @return [String]
+    attr_accessor :invoice_uid
+
+    # The current status of the invoice. See [Invoice
+    # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#lin
+    # e-item-breakdowns) for more.
+    # @return [Status]
+    attr_accessor :status
+
+    # The remaining due amount on the invoice
+    # @return [String]
+    attr_accessor :due_amount
+
+    # The total amount paid on this invoice (including any prior payments)
+    # @return [String]
+    attr_accessor :paid_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice_uid'] = 'invoice_uid'
+      @_hash['status'] = 'status'
+      @_hash['due_amount'] = 'due_amount'
+      @_hash['paid_amount'] = 'paid_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        invoice_uid
+        status
+        due_amount
+        paid_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(invoice_uid = SKIP, status = SKIP, due_amount = SKIP,
+                   paid_amount = SKIP)
+      @invoice_uid = invoice_uid unless invoice_uid == SKIP
+      @status = status unless status == SKIP
+      @due_amount = due_amount unless due_amount == SKIP
+      @paid_amount = paid_amount unless paid_amount == 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_uid = hash.key?('invoice_uid') ? hash['invoice_uid'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      due_amount = hash.key?('due_amount') ? hash['due_amount'] : SKIP
+      paid_amount = hash.key?('paid_amount') ? hash['paid_amount'] : SKIP
+
+      # Create object from extracted values.
+      Payment.new(invoice_uid,
+                  status,
+                  due_amount,
+                  paid_amount)
+    end
+  end
+end

data/lib/advanced_billing/models/payment_collection_method.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The type of payment collection to be used in the subscription. For legacy
+  # Statements Architecture valid options are - `invoice`, `automatic`. For
+  # current Relationship Invoicing Architecture valid options are -
+  # `remittance`, `automatic`, `prepaid`.
+  class PaymentCollectionMethod
+    PAYMENT_COLLECTION_METHOD = [
+      # TODO: Write general description for AUTOMATIC
+      AUTOMATIC = 'automatic'.freeze,
+
+      # TODO: Write general description for REMITTANCE
+      REMITTANCE = 'remittance'.freeze,
+
+      # TODO: Write general description for PREPAID
+      PREPAID = 'prepaid'.freeze,
+
+      # TODO: Write general description for INVOICE
+      INVOICE = 'invoice'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_COLLECTION_METHOD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/payment_collection_method1.rb

@@ -0,0 +1,30 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # (Optional) If not passed, the allocation(s) will use the payment collection
+  # method on the subscription
+  class PaymentCollectionMethod1
+    PAYMENT_COLLECTION_METHOD1 = [
+      # TODO: Write general description for AUTOMATIC
+      AUTOMATIC = 'automatic'.freeze,
+
+      # TODO: Write general description for REMITTANCE
+      REMITTANCE = 'remittance'.freeze,
+
+      # TODO: Write general description for PREPAID
+      PREPAID = 'prepaid'.freeze,
+
+      # TODO: Write general description for INVOICE
+      INVOICE = 'invoice'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_COLLECTION_METHOD1.include?(value)
+    end
+  end
+end