orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/update_alert_query_params.rb

@@ -0,0 +1,65 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # UpdateAlertQueryParams Model.
+  class UpdateAlertQueryParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Used to update the status of a plan alert scoped to this subscription_id
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        subscription_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        subscription_id
+      ]
+    end
+
+    def initialize(subscription_id: SKIP)
+      @subscription_id = subscription_id unless subscription_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.
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
+
+      # Create object from extracted values.
+      UpdateAlertQueryParams.new(subscription_id: subscription_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} subscription_id: #{@subscription_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} subscription_id: #{@subscription_id.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/update_alert_request_params.rb

@@ -0,0 +1,116 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # UpdateAlertRequestParams Model.
+  class UpdateAlertRequestParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The thresholds that define the values at which the alert will be
+    # triggered.
+    # @return [Array[Threshold]]
+    attr_accessor :thresholds
+
+    # Replaces the price filters on a grouped cost alert; an empty list clears
+    # them. Only applicable to cost alerts with grouping_keys. Omit to leave
+    # unchanged.
+    # @return [Array[PriceFilter]]
+    attr_accessor :price_filters
+
+    # Replaces the per-group threshold overrides on a grouped cost alert; an
+    # empty list clears them. Only applicable to cost alerts with grouping_keys.
+    # Omit to leave unchanged.
+    # @return [Array[ThresholdOverrideParams]]
+    attr_accessor :threshold_overrides
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['thresholds'] = 'thresholds'
+      @_hash['price_filters'] = 'price_filters'
+      @_hash['threshold_overrides'] = 'threshold_overrides'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        price_filters
+        threshold_overrides
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        price_filters
+        threshold_overrides
+      ]
+    end
+
+    def initialize(thresholds:, price_filters: SKIP, threshold_overrides: SKIP)
+      @thresholds = thresholds
+      @price_filters = price_filters unless price_filters == SKIP
+      @threshold_overrides = threshold_overrides unless threshold_overrides == 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
+      thresholds = nil
+      unless hash['thresholds'].nil?
+        thresholds = []
+        hash['thresholds'].each do |structure|
+          thresholds << (Threshold.from_hash(structure) if structure)
+        end
+      end
+
+      thresholds = nil unless hash.key?('thresholds')
+      # Parameter is an array, so we need to iterate through it
+      price_filters = nil
+      unless hash['price_filters'].nil?
+        price_filters = []
+        hash['price_filters'].each do |structure|
+          price_filters << (PriceFilter.from_hash(structure) if structure)
+        end
+      end
+
+      price_filters = SKIP unless hash.key?('price_filters')
+      # Parameter is an array, so we need to iterate through it
+      threshold_overrides = nil
+      unless hash['threshold_overrides'].nil?
+        threshold_overrides = []
+        hash['threshold_overrides'].each do |structure|
+          threshold_overrides << (ThresholdOverrideParams.from_hash(structure) if structure)
+        end
+      end
+
+      threshold_overrides = SKIP unless hash.key?('threshold_overrides')
+
+      # Create object from extracted values.
+      UpdateAlertRequestParams.new(thresholds: thresholds,
+                                   price_filters: price_filters,
+                                   threshold_overrides: threshold_overrides)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} thresholds: #{@thresholds}, price_filters: #{@price_filters},"\
+      " threshold_overrides: #{@threshold_overrides}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} thresholds: #{@thresholds.inspect}, price_filters:"\
+      " #{@price_filters.inspect}, threshold_overrides: #{@threshold_overrides.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/update_invoice_request_params.rb

@@ -0,0 +1,145 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # UpdateInvoiceRequestParams Model.
+  class UpdateInvoiceRequestParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User-specified key/value pairs for the resource. Individual keys can be
+    # removed by setting the value to `null`, and the entire metadata mapping
+    # can be cleared by setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # The net terms determines the due date of the invoice. Due date is
+    # calculated based on the invoice or issuance date, depending on the
+    # account's configured due date calculation method. A value of '0' here
+    # represents that the invoice is due on issue, whereas a value of '30'
+    # represents that the customer has 30 days to pay the invoice. Do not set
+    # this field if you want to set a custom due date.
+    # @return [Integer]
+    attr_accessor :net_terms
+
+    # An optional custom due date for the invoice. If not set, the due date will
+    # be calculated based on the `net_terms` value.
+    # @return [Object]
+    attr_accessor :due_date
+
+    # The date of the invoice. Can only be modified for one-off draft invoices.
+    # @return [Object]
+    attr_accessor :invoice_date
+
+    # Determines whether this invoice will automatically attempt to charge a
+    # saved payment method, if any. Can only be modified on draft invoices. If
+    # not specified, the invoice's existing setting is unchanged.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_collection
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['due_date'] = 'due_date'
+      @_hash['invoice_date'] = 'invoice_date'
+      @_hash['auto_collection'] = 'auto_collection'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        net_terms
+        due_date
+        invoice_date
+        auto_collection
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        net_terms
+        due_date
+        invoice_date
+        auto_collection
+      ]
+    end
+
+    def initialize(metadata: SKIP, net_terms: SKIP, due_date: SKIP,
+                   invoice_date: SKIP, auto_collection: SKIP)
+      @metadata = metadata unless metadata == SKIP
+      @net_terms = net_terms unless net_terms == SKIP
+      @due_date = due_date unless due_date == SKIP
+      @invoice_date = invoice_date unless invoice_date == SKIP
+      @auto_collection = auto_collection unless auto_collection == 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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      net_terms = hash.key?('net_terms') ? hash['net_terms'] : SKIP
+      due_date = hash.key?('due_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:UpdateInvoiceRequestParamsDueDate), hash['due_date']
+      ) : SKIP
+      invoice_date = hash.key?('invoice_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:UpdateInvoiceRequestParamsInvoiceDate), hash['invoice_date']
+      ) : SKIP
+      auto_collection =
+        hash.key?('auto_collection') ? hash['auto_collection'] : SKIP
+
+      # Create object from extracted values.
+      UpdateInvoiceRequestParams.new(metadata: metadata,
+                                     net_terms: net_terms,
+                                     due_date: due_date,
+                                     invoice_date: invoice_date,
+                                     auto_collection: auto_collection)
+    end
+
+    def to_union_type_due_date
+      UnionTypeLookUp.get(:UpdateInvoiceRequestParamsDueDate)
+                     .validate(due_date)
+                     .serialize(due_date)
+    end
+
+    def to_union_type_invoice_date
+      UnionTypeLookUp.get(:UpdateInvoiceRequestParamsInvoiceDate)
+                     .validate(invoice_date)
+                     .serialize(invoice_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [UpdateInvoiceRequestParams | 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, net_terms: #{@net_terms}, due_date: #{@due_date},"\
+      " invoice_date: #{@invoice_date}, auto_collection: #{@auto_collection}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}, net_terms: #{@net_terms.inspect}, due_date:"\
+      " #{@due_date.inspect}, invoice_date: #{@invoice_date.inspect}, auto_collection:"\
+      " #{@auto_collection.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/update_metric_request_params.rb

@@ -0,0 +1,66 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # UpdateMetricRequestParams Model.
+  class UpdateMetricRequestParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User-specified key/value pairs for the resource. Individual keys can be
+    # removed by setting the value to `null`, and the entire metadata mapping
+    # can be cleared by setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+      ]
+    end
+
+    def initialize(metadata: 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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      UpdateMetricRequestParams.new(metadata: metadata)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/update_price_request_params.rb

@@ -0,0 +1,66 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # UpdatePriceRequestParams Model.
+  class UpdatePriceRequestParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User-specified key/value pairs for the resource. Individual keys can be
+    # removed by setting the value to `null`, and the entire metadata mapping
+    # can be cleared by setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+      ]
+    end
+
+    def initialize(metadata: 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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      UpdatePriceRequestParams.new(metadata: metadata)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/update_subscription_params.rb

@@ -0,0 +1,137 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # UpdateSubscriptionParams Model.
+  class UpdateSubscriptionParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User-specified key/value pairs for the resource. Individual keys can be
+    # removed by setting the value to `null`, and the entire metadata mapping
+    # can be cleared by setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # Determines the default memo on this subscription's invoices. Note that if
+    # this is not provided, it is determined by the plan configuration.
+    # @return [String]
+    attr_accessor :default_invoice_memo
+
+    # Determines whether issued invoices for this subscription will
+    # automatically be charged with the saved payment method on the due date.
+    # This property defaults to the plan's behavior.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_collection
+
+    # Used to determine if invoices for this subscription will be automatically
+    # issued. If true, invoices will be automatically issued. If false, invoices
+    # will require manual approval. If `null` is specified, this defaults to the
+    # behavior configured for this customer.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_issuance
+
+    # Determines the difference between the invoice issue date for subscription
+    # invoices as the date that they are due. A value of `0` here represents
+    # that the invoice is due on issue, whereas a value of `30` represents that
+    # the customer has a month to pay the invoice.
+    # @return [Integer]
+    attr_accessor :net_terms
+
+    # When this subscription's accrued usage reaches this threshold, an invoice
+    # will be issued for the subscription. If not specified, invoices will only
+    # be issued at the end of the billing period.
+    # @return [String]
+    attr_accessor :invoicing_threshold
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['default_invoice_memo'] = 'default_invoice_memo'
+      @_hash['auto_collection'] = 'auto_collection'
+      @_hash['auto_issuance'] = 'auto_issuance'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['invoicing_threshold'] = 'invoicing_threshold'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        default_invoice_memo
+        auto_collection
+        auto_issuance
+        net_terms
+        invoicing_threshold
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        default_invoice_memo
+        auto_collection
+        auto_issuance
+        net_terms
+        invoicing_threshold
+      ]
+    end
+
+    def initialize(metadata: SKIP, default_invoice_memo: SKIP,
+                   auto_collection: SKIP, auto_issuance: SKIP, net_terms: SKIP,
+                   invoicing_threshold: SKIP)
+      @metadata = metadata unless metadata == SKIP
+      @default_invoice_memo = default_invoice_memo unless default_invoice_memo == SKIP
+      @auto_collection = auto_collection unless auto_collection == SKIP
+      @auto_issuance = auto_issuance unless auto_issuance == SKIP
+      @net_terms = net_terms unless net_terms == SKIP
+      @invoicing_threshold = invoicing_threshold unless invoicing_threshold == 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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      default_invoice_memo =
+        hash.key?('default_invoice_memo') ? hash['default_invoice_memo'] : SKIP
+      auto_collection =
+        hash.key?('auto_collection') ? hash['auto_collection'] : SKIP
+      auto_issuance = hash.key?('auto_issuance') ? hash['auto_issuance'] : SKIP
+      net_terms = hash.key?('net_terms') ? hash['net_terms'] : SKIP
+      invoicing_threshold =
+        hash.key?('invoicing_threshold') ? hash['invoicing_threshold'] : SKIP
+
+      # Create object from extracted values.
+      UpdateSubscriptionParams.new(metadata: metadata,
+                                   default_invoice_memo: default_invoice_memo,
+                                   auto_collection: auto_collection,
+                                   auto_issuance: auto_issuance,
+                                   net_terms: net_terms,
+                                   invoicing_threshold: invoicing_threshold)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, default_invoice_memo: #{@default_invoice_memo},"\
+      " auto_collection: #{@auto_collection}, auto_issuance: #{@auto_issuance}, net_terms:"\
+      " #{@net_terms}, invoicing_threshold: #{@invoicing_threshold}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}, default_invoice_memo:"\
+      " #{@default_invoice_memo.inspect}, auto_collection: #{@auto_collection.inspect},"\
+      " auto_issuance: #{@auto_issuance.inspect}, net_terms: #{@net_terms.inspect},"\
+      " invoicing_threshold: #{@invoicing_threshold.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/update_trial_request_params.rb

@@ -0,0 +1,94 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # UpdateTrialRequestParams Model.
+  class UpdateTrialRequestParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The new date that the trial should end, or the literal string `immediate`
+    # to end the trial immediately.
+    # @return [Object]
+    attr_accessor :trial_end_date
+
+    # If true, shifts subsequent price and adjustment intervals (preserving
+    # their durations, but adjusting their absolute dates).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :shift
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['trial_end_date'] = 'trial_end_date'
+      @_hash['shift'] = 'shift'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        shift
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(trial_end_date:, shift: false)
+      @trial_end_date = trial_end_date
+      @shift = shift unless shift == 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.
+      trial_end_date = hash.key?('trial_end_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:UpdateTrialRequestParamsTrialEndDate), hash['trial_end_date']
+      ) : nil
+      shift = hash['shift'] ||= false
+
+      # Create object from extracted values.
+      UpdateTrialRequestParams.new(trial_end_date: trial_end_date,
+                                   shift: shift)
+    end
+
+    def to_union_type_trial_end_date
+      UnionTypeLookUp.get(:UpdateTrialRequestParamsTrialEndDate)
+                     .validate(trial_end_date)
+                     .serialize(trial_end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [UpdateTrialRequestParams | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return UnionTypeLookUp.get(:UpdateTrialRequestParamsTrialEndDate)
+                              .validate(value.trial_end_date)
+      end
+
+      return false unless value.instance_of? Hash
+
+      UnionTypeLookUp.get(:UpdateTrialRequestParamsTrialEndDate)
+                     .validate(value['trial_end_date'])
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} trial_end_date: #{@trial_end_date}, shift: #{@shift}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} trial_end_date: #{@trial_end_date.inspect}, shift: #{@shift.inspect}>"
+    end
+  end
+end