maxio-advanced-billing-sdk 2.0.0 → 3.0.0

data/lib/advanced_billing/models/list_coupons_filter.rb

@@ -0,0 +1,168 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # ListCouponsFilter Model.
+  class ListCouponsFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of filter you would like to apply to your search. Use in query
+    # `filter[date_field]=created_at`.
+    # @return [BasicDateField]
+    attr_accessor :date_field
+
+    # The start date (format YYYY-MM-DD) with which to filter the date_field.
+    # Returns coupons with a timestamp at or after midnight (12:00:00 AM) in
+    # your site’s time zone on the date specified. Use in query
+    # `filter[start_date]=2011-12-17`.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # The end date (format YYYY-MM-DD) with which to filter the date_field.
+    # Returns coupons with a timestamp up to and including 11:59:59PM in your
+    # site’s time zone on the date specified. Use in query
+    # `filter[end_date]=2011-12-15`.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter
+    # the date_field. Returns coupons with a timestamp at or after exact time
+    # provided in query. You can specify timezone in query - otherwise your
+    # site's time zone will be used. If provided, this parameter will be used
+    # instead of start_date. Use in query
+    # `filter[start_datetime]=2011-12-19T10:15:30+01:00`.
+    # @return [DateTime]
+    attr_accessor :start_datetime
+
+    # The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter
+    # the date_field. Returns coupons with a timestamp at or before exact time
+    # provided in query. You can specify timezone in query - otherwise your
+    # site's time zone will be used. If provided, this parameter will be used
+    # instead of end_date. Use in query
+    # `filter[end_datetime]=2011-12-1T10:15:30+01:00`.
+    # @return [DateTime]
+    attr_accessor :end_datetime
+
+    # Allows fetching coupons with matching id based on provided values. Use in
+    # query `filter[ids]=1,2,3`.
+    # @return [Array[Integer]]
+    attr_accessor :ids
+
+    # Allows fetching coupons with matching codes based on provided values. Use
+    # in query `filter[codes]=free,free_trial`.
+    # @return [Array[String]]
+    attr_accessor :codes
+
+    # Allows fetching coupons with matching use_site_exchange_rate based on
+    # provided value. Use in query `filter[use_site_exchange_rate]=true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_site_exchange_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date_field'] = 'date_field'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['start_datetime'] = 'start_datetime'
+      @_hash['end_datetime'] = 'end_datetime'
+      @_hash['ids'] = 'ids'
+      @_hash['codes'] = 'codes'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date_field
+        start_date
+        end_date
+        start_datetime
+        end_datetime
+        ids
+        codes
+        use_site_exchange_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date_field = SKIP,
+                   start_date = SKIP,
+                   end_date = SKIP,
+                   start_datetime = SKIP,
+                   end_datetime = SKIP,
+                   ids = SKIP,
+                   codes = SKIP,
+                   use_site_exchange_rate = SKIP,
+                   additional_properties = {})
+      @date_field = date_field unless date_field == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @start_datetime = start_datetime unless start_datetime == SKIP
+      @end_datetime = end_datetime unless end_datetime == SKIP
+      @ids = ids unless ids == SKIP
+      @codes = codes unless codes == SKIP
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == SKIP
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      date_field = hash.key?('date_field') ? hash['date_field'] : SKIP
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      start_datetime = if hash.key?('start_datetime')
+                         (DateTimeHelper.from_rfc3339(hash['start_datetime']) if hash['start_datetime'])
+                       else
+                         SKIP
+                       end
+      end_datetime = if hash.key?('end_datetime')
+                       (DateTimeHelper.from_rfc3339(hash['end_datetime']) if hash['end_datetime'])
+                     else
+                       SKIP
+                     end
+      ids = hash.key?('ids') ? hash['ids'] : SKIP
+      codes = hash.key?('codes') ? hash['codes'] : SKIP
+      use_site_exchange_rate =
+        hash.key?('use_site_exchange_rate') ? hash['use_site_exchange_rate'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ListCouponsFilter.new(date_field,
+                            start_date,
+                            end_date,
+                            start_datetime,
+                            end_datetime,
+                            ids,
+                            codes,
+                            use_site_exchange_rate,
+                            hash)
+    end
+
+    def to_custom_start_datetime
+      DateTimeHelper.to_rfc3339(start_datetime)
+    end
+
+    def to_custom_end_datetime
+      DateTimeHelper.to_rfc3339(end_datetime)
+    end
+  end
+end

data/lib/advanced_billing/models/list_invoice_events_response.rb

@@ -10,7 +10,7 @@ module AdvancedBilling
     private_constant :SKIP
 
     # TODO: Write general description for this method
-    # @return [Array[InvoiceEvent]]
+    # @return [Array[Object]]
     attr_accessor :events
 
     # TODO: Write general description for this method
@@ -71,16 +71,9 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
-      # Parameter is an array, so we need to iterate through it
-      events = nil
-      unless hash['events'].nil?
-        events = []
-        hash['events'].each do |structure|
-          events << (InvoiceEvent.from_hash(structure) if structure)
-        end
-      end
-
-      events = SKIP unless hash.key?('events')
+      events = hash.key?('events') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:InvoiceEvent), hash['events']
+      ) : SKIP
       page = hash.key?('page') ? hash['page'] : SKIP
       per_page = hash.key?('per_page') ? hash['per_page'] : SKIP
       total_pages = hash.key?('total_pages') ? hash['total_pages'] : SKIP
@@ -95,5 +88,15 @@ module AdvancedBilling
                                     total_pages,
                                     hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [ListInvoiceEventsResponse | 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/{refund_prepayment_aggregated_error.rb → list_mrr_filter.rb}

@@ -4,26 +4,27 @@
 # ( https://apimatic.io ).
 
 module AdvancedBilling
-  # RefundPrepaymentAggregatedError Model.
-  class RefundPrepaymentAggregatedError < BaseModel
+  # ListMrrFilter Model.
+  class ListMrrFilter < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # TODO: Write general description for this method
-    # @return [PrepaymentAggregatedError]
-    attr_accessor :refund
+    # Submit ids in order to limit results. Use in query:
+    # `filter[subscription_ids]=1,2,3`.
+    # @return [Array[Integer]]
+    attr_accessor :subscription_ids
 
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
-      @_hash['refund'] = 'refund'
+      @_hash['subscription_ids'] = 'subscription_ids'
       @_hash
     end
 
     # An array for optional fields
     def self.optionals
       %w[
-        refund
+        subscription_ids
       ]
     end
 
@@ -32,9 +33,9 @@ module AdvancedBilling
       []
     end
 
-    def initialize(refund = SKIP,
+    def initialize(subscription_ids = SKIP,
                    additional_properties = {})
-      @refund = refund unless refund == SKIP
+      @subscription_ids = subscription_ids unless subscription_ids == SKIP
 
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
@@ -47,14 +48,15 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
-      refund = PrepaymentAggregatedError.from_hash(hash['refund']) if hash['refund']
+      subscription_ids =
+        hash.key?('subscription_ids') ? hash['subscription_ids'] : SKIP
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
-      RefundPrepaymentAggregatedError.new(refund,
-                                          hash)
+      ListMrrFilter.new(subscription_ids,
+                        hash)
     end
   end
 end

data/lib/advanced_billing/models/{list_subscription_group_prepayment_date_field.rb → list_prepayment_date_field.rb}

@@ -4,9 +4,9 @@
 # ( https://apimatic.io ).
 
 module AdvancedBilling
-  # List Subscription Group Prepayment Date Field.
-  class ListSubscriptionGroupPrepaymentDateField
-    LIST_SUBSCRIPTION_GROUP_PREPAYMENT_DATE_FIELD = [
+  # List Prepayment Date Field.
+  class ListPrepaymentDateField
+    LIST_PREPAYMENT_DATE_FIELD = [
       # TODO: Write general description for CREATED_AT
       CREATED_AT = 'created_at'.freeze,
 
@@ -17,7 +17,7 @@ module AdvancedBilling
     def self.validate(value)
       return false if value.nil?
 
-      LIST_SUBSCRIPTION_GROUP_PREPAYMENT_DATE_FIELD.include?(value)
+      LIST_PREPAYMENT_DATE_FIELD.include?(value)
     end
   end
 end

data/lib/advanced_billing/models/list_prepayments_filter.rb

@@ -0,0 +1,88 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListPrepaymentsFilter Model.
+  class ListPrepaymentsFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of filter you would like to apply to your search. `created_at` -
+    # Time when prepayment was created. `application_at` - Time when prepayment
+    # was applied to invoice. Use in query `filter[date_field]=created_at`.
+    # @return [ListPrepaymentDateField]
+    attr_accessor :date_field
+
+    # The start date (format YYYY-MM-DD) with which to filter the date_field.
+    # Returns prepayments with a timestamp at or after midnight (12:00:00 AM) in
+    # your site's time zone on the date specified. Use in query:
+    # `filter[start_date]=2011-12-15`.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # The end date (format YYYY-MM-DD) with which to filter the date_field.
+    # Returns prepayments with a timestamp up to and including 11:59:59PM in
+    # your site's time zone on the date specified. Use in query:
+    # `filter[end_date]=2011-12-15`.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date_field'] = 'date_field'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date_field
+        start_date
+        end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date_field = SKIP,
+                   start_date = SKIP,
+                   end_date = SKIP,
+                   additional_properties = {})
+      @date_field = date_field unless date_field == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      date_field = hash.key?('date_field') ? hash['date_field'] : SKIP
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ListPrepaymentsFilter.new(date_field,
+                                start_date,
+                                end_date,
+                                hash)
+    end
+  end
+end

data/lib/advanced_billing/models/list_price_points_filter.rb

@@ -0,0 +1,163 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # ListPricePointsFilter Model.
+  class ListPricePointsFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of filter you would like to apply to your search. Use in query:
+    # `filter[date_field]=created_at`.
+    # @return [BasicDateField]
+    attr_accessor :date_field
+
+    # The start date (format YYYY-MM-DD) with which to filter the date_field.
+    # Returns price points with a timestamp at or after midnight (12:00:00 AM)
+    # in your site’s time zone on the date specified.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # The end date (format YYYY-MM-DD) with which to filter the date_field.
+    # Returns price points with a timestamp up to and including 11:59:59PM in
+    # your site’s time zone on the date specified.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter
+    # the date_field. Returns price points with a timestamp at or after exact
+    # time provided in query. You can specify timezone in query - otherwise your
+    # site's time zone will be used. If provided, this parameter will be used
+    # instead of start_date.
+    # @return [DateTime]
+    attr_accessor :start_datetime
+
+    # The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter
+    # the date_field. Returns price points with a timestamp at or before exact
+    # time provided in query. You can specify timezone in query - otherwise your
+    # site's time zone will be used. If provided, this parameter will be used
+    # instead of end_date.
+    # @return [DateTime]
+    attr_accessor :end_datetime
+
+    # Allows fetching price points with matching type. Use in query:
+    # `filter[type]=custom,catalog`.
+    # @return [Array[PricePointType]]
+    attr_accessor :type
+
+    # Allows fetching price points with matching id based on provided values.
+    # Use in query: `filter[ids]=1,2,3`.
+    # @return [Array[Integer]]
+    attr_accessor :ids
+
+    # Allows fetching price points only if archived_at is present or not. Use in
+    # query: `filter[archived_at]=not_null`.
+    # @return [IncludeNullOrNotNull]
+    attr_accessor :archived_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date_field'] = 'date_field'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['start_datetime'] = 'start_datetime'
+      @_hash['end_datetime'] = 'end_datetime'
+      @_hash['type'] = 'type'
+      @_hash['ids'] = 'ids'
+      @_hash['archived_at'] = 'archived_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date_field
+        start_date
+        end_date
+        start_datetime
+        end_datetime
+        type
+        ids
+        archived_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date_field = SKIP,
+                   start_date = SKIP,
+                   end_date = SKIP,
+                   start_datetime = SKIP,
+                   end_datetime = SKIP,
+                   type = SKIP,
+                   ids = SKIP,
+                   archived_at = SKIP,
+                   additional_properties = {})
+      @date_field = date_field unless date_field == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @start_datetime = start_datetime unless start_datetime == SKIP
+      @end_datetime = end_datetime unless end_datetime == SKIP
+      @type = type unless type == SKIP
+      @ids = ids unless ids == SKIP
+      @archived_at = archived_at unless archived_at == SKIP
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      date_field = hash.key?('date_field') ? hash['date_field'] : SKIP
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      start_datetime = if hash.key?('start_datetime')
+                         (DateTimeHelper.from_rfc3339(hash['start_datetime']) if hash['start_datetime'])
+                       else
+                         SKIP
+                       end
+      end_datetime = if hash.key?('end_datetime')
+                       (DateTimeHelper.from_rfc3339(hash['end_datetime']) if hash['end_datetime'])
+                     else
+                       SKIP
+                     end
+      type = hash.key?('type') ? hash['type'] : SKIP
+      ids = hash.key?('ids') ? hash['ids'] : SKIP
+      archived_at = hash.key?('archived_at') ? hash['archived_at'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ListPricePointsFilter.new(date_field,
+                                start_date,
+                                end_date,
+                                start_datetime,
+                                end_datetime,
+                                type,
+                                ids,
+                                archived_at,
+                                hash)
+    end
+
+    def to_custom_start_datetime
+      DateTimeHelper.to_rfc3339(start_datetime)
+    end
+
+    def to_custom_end_datetime
+      DateTimeHelper.to_rfc3339(end_datetime)
+    end
+  end
+end

data/lib/advanced_billing/models/list_products_filter.rb

@@ -0,0 +1,81 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListProductsFilter Model.
+  class ListProductsFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Allows fetching products only if a prepaid product price point is present
+    # or not. To use this filter you also have to include the following param in
+    # the request `include=prepaid_product_price_point`. Use in query
+    # `filter[prepaid_product_price_point][product_price_point_id]=not_null`.
+    # @return [PrepaidProductPricePointFilter]
+    attr_accessor :prepaid_product_price_point
+
+    # Allows fetching products with matching use_site_exchange_rate based on
+    # provided value (refers to default price point). Use in query
+    # `filter[use_site_exchange_rate]=true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_site_exchange_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prepaid_product_price_point'] = 'prepaid_product_price_point'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        prepaid_product_price_point
+        use_site_exchange_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prepaid_product_price_point = SKIP,
+                   use_site_exchange_rate = SKIP,
+                   additional_properties = {})
+      unless prepaid_product_price_point == SKIP
+        @prepaid_product_price_point =
+          prepaid_product_price_point
+      end
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == SKIP
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      if hash['prepaid_product_price_point']
+        prepaid_product_price_point = PrepaidProductPricePointFilter.from_hash(hash['prepaid_product_price_point'])
+      end
+      use_site_exchange_rate =
+        hash.key?('use_site_exchange_rate') ? hash['use_site_exchange_rate'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ListProductsFilter.new(prepaid_product_price_point,
+                             use_site_exchange_rate,
+                             hash)
+    end
+  end
+end