subtain-apimatic-sdk 4.1.1 → 9.1.2

data/lib/advanced_billing/models/create_currency_price.rb

@@ -0,0 +1,68 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateCurrencyPrice Model.
+  class CreateCurrencyPrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO code for a currency defined on the site level
+    # @return [String]
+    attr_accessor :currency
+
+    # Price for the price level in this currency
+    # @return [Integer]
+    attr_accessor :price
+
+    # ID of the price that this corresponds with
+    # @return [Integer]
+    attr_accessor :price_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['price'] = 'price'
+      @_hash['price_id'] = 'price_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+        price
+        price_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency = SKIP, price = SKIP, price_id = SKIP)
+      @currency = currency unless currency == SKIP
+      @price = price unless price == SKIP
+      @price_id = price_id unless price_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.
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      price = hash.key?('price') ? hash['price'] : SKIP
+      price_id = hash.key?('price_id') ? hash['price_id'] : SKIP
+
+      # Create object from extracted values.
+      CreateCurrencyPrice.new(currency,
+                              price,
+                              price_id)
+    end
+  end
+end

data/lib/advanced_billing/models/create_currency_prices_request.rb

@@ -0,0 +1,57 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateCurrencyPricesRequest Model.
+  class CreateCurrencyPricesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CreateCurrencyPrice]]
+    attr_accessor :currency_prices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency_prices'] = 'currency_prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency_prices = nil)
+      @currency_prices = currency_prices
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      currency_prices = nil
+      unless hash['currency_prices'].nil?
+        currency_prices = []
+        hash['currency_prices'].each do |structure|
+          currency_prices << (CreateCurrencyPrice.from_hash(structure) if structure)
+        end
+      end
+
+      currency_prices = nil unless hash.key?('currency_prices')
+
+      # Create object from extracted values.
+      CreateCurrencyPricesRequest.new(currency_prices)
+    end
+  end
+end

data/lib/advanced_billing/models/create_customer.rb

@@ -0,0 +1,209 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateCustomer Model.
+  class CreateCustomer < 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
+
+    # Set a specific language on a customer record.
+    # @return [String]
+    attr_accessor :locale
+
+    # Set a specific language on a customer record.
+    # @return [String]
+    attr_accessor :vat_number
+
+    # Set a specific language on a customer record.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_exempt
+
+    # Set a specific language on a customer record.
+    # @return [String]
+    attr_accessor :tax_exempt_reason
+
+    # The parent ID in Chargify if applicable. Parent is another Customer
+    # object.
+    # @return [Integer]
+    attr_accessor :parent_id
+
+    # 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['parent_id'] = 'parent_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cc_emails
+        organization
+        reference
+        address
+        address_2
+        city
+        state
+        zip
+        country
+        phone
+        locale
+        vat_number
+        tax_exempt
+        tax_exempt_reason
+        parent_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        parent_id
+      ]
+    end
+
+    def initialize(first_name = nil, last_name = nil, email = nil,
+                   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, parent_id = SKIP)
+      @first_name = first_name
+      @last_name = last_name
+      @email = email
+      @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
+      @parent_id = parent_id unless parent_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.
+      first_name = hash.key?('first_name') ? hash['first_name'] : nil
+      last_name = hash.key?('last_name') ? hash['last_name'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+      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
+      parent_id = hash.key?('parent_id') ? hash['parent_id'] : SKIP
+
+      # Create object from extracted values.
+      CreateCustomer.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,
+                         parent_id)
+    end
+  end
+end

data/lib/advanced_billing/models/create_customer_request.rb

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

data/lib/advanced_billing/models/create_ebb_component.rb

@@ -0,0 +1,65 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateEBBComponent Model.
+  class CreateEBBComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [EBBComponent]
+    attr_accessor :event_based_component
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_based_component'] = 'event_based_component'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(event_based_component = nil)
+      @event_based_component = event_based_component
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      event_based_component = EBBComponent.from_hash(hash['event_based_component']) if
+        hash['event_based_component']
+
+      # Create object from extracted values.
+      CreateEBBComponent.new(event_based_component)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateEBBComponent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.event_based_component,
+                                     ->(val) { EBBComponent.validate(val) },
+                                     is_model_hash: true)
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['event_based_component'],
+                            ->(val) { EBBComponent.validate(val) },
+                            is_model_hash: true)
+    end
+  end
+end

data/lib/advanced_billing/models/create_invoice.rb

@@ -0,0 +1,163 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateInvoice Model.
+  class CreateInvoice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CreateInvoiceItem]]
+    attr_accessor :line_items
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :issue_date
+
+    # By default, invoices will be created with a due date matching the date of
+    # invoice creation. If a different due date is desired, the net_terms
+    # parameter can be sent indicating the number of days in advance the due
+    # date should be.
+    # @return [Integer]
+    attr_accessor :net_terms
+
+    # By default, invoices will be created with a due date matching the date of
+    # invoice creation. If a different due date is desired, the net_terms
+    # parameter can be sent indicating the number of days in advance the due
+    # date should be.
+    # @return [String]
+    attr_accessor :payment_instructions
+
+    # A custom memo can be sent to override the site's default.
+    # @return [String]
+    attr_accessor :memo
+
+    # Overrides the defaults for the site
+    # @return [CreateInvoiceAddress]
+    attr_accessor :seller_address
+
+    # Overrides the default for the customer
+    # @return [CreateInvoiceAddress]
+    attr_accessor :billing_address
+
+    # Overrides the default for the customer
+    # @return [CreateInvoiceAddress]
+    attr_accessor :shipping_address
+
+    # Overrides the default for the customer
+    # @return [Array[CreateInvoiceCoupon]]
+    attr_accessor :coupons
+
+    # Overrides the default for the customer
+    # @return [Status1]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line_items'] = 'line_items'
+      @_hash['issue_date'] = 'issue_date'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['payment_instructions'] = 'payment_instructions'
+      @_hash['memo'] = 'memo'
+      @_hash['seller_address'] = 'seller_address'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['coupons'] = 'coupons'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line_items
+        issue_date
+        net_terms
+        payment_instructions
+        memo
+        seller_address
+        billing_address
+        shipping_address
+        coupons
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line_items = SKIP, issue_date = SKIP, net_terms = SKIP,
+                   payment_instructions = SKIP, memo = SKIP,
+                   seller_address = SKIP, billing_address = SKIP,
+                   shipping_address = SKIP, coupons = SKIP,
+                   status = Status1::OPEN)
+      @line_items = line_items unless line_items == SKIP
+      @issue_date = issue_date unless issue_date == SKIP
+      @net_terms = net_terms unless net_terms == SKIP
+      @payment_instructions = payment_instructions unless payment_instructions == SKIP
+      @memo = memo unless memo == SKIP
+      @seller_address = seller_address unless seller_address == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @coupons = coupons unless coupons == SKIP
+      @status = status unless status == 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.
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (CreateInvoiceItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = SKIP unless hash.key?('line_items')
+      issue_date = hash.key?('issue_date') ? hash['issue_date'] : SKIP
+      net_terms = hash.key?('net_terms') ? hash['net_terms'] : SKIP
+      payment_instructions =
+        hash.key?('payment_instructions') ? hash['payment_instructions'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      seller_address = CreateInvoiceAddress.from_hash(hash['seller_address']) if
+        hash['seller_address']
+      billing_address = CreateInvoiceAddress.from_hash(hash['billing_address']) if
+        hash['billing_address']
+      shipping_address = CreateInvoiceAddress.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      # Parameter is an array, so we need to iterate through it
+      coupons = nil
+      unless hash['coupons'].nil?
+        coupons = []
+        hash['coupons'].each do |structure|
+          coupons << (CreateInvoiceCoupon.from_hash(structure) if structure)
+        end
+      end
+
+      coupons = SKIP unless hash.key?('coupons')
+      status = hash['status'] ||= Status1::OPEN
+
+      # Create object from extracted values.
+      CreateInvoice.new(line_items,
+                        issue_date,
+                        net_terms,
+                        payment_instructions,
+                        memo,
+                        seller_address,
+                        billing_address,
+                        shipping_address,
+                        coupons,
+                        status)
+    end
+  end
+end