orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/coupon_query_params.rb

@@ -0,0 +1,99 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CouponQueryParams Model.
+  class CouponQueryParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number of items to fetch. Defaults to 20.
+    # @return [Integer]
+    attr_accessor :limit
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [String]
+    attr_accessor :cursor
+
+    # Show archived coupons as well (by default, this endpoint only returns
+    # active coupons).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_archived
+
+    # Filter to coupons matching this redemption code.
+    # @return [String]
+    attr_accessor :redemption_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['limit'] = 'limit'
+      @_hash['cursor'] = 'cursor'
+      @_hash['show_archived'] = 'show_archived'
+      @_hash['redemption_code'] = 'redemption_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        limit
+        cursor
+        show_archived
+        redemption_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cursor
+        show_archived
+        redemption_code
+      ]
+    end
+
+    def initialize(limit: 20, cursor: SKIP, show_archived: SKIP,
+                   redemption_code: SKIP)
+      @limit = limit unless limit == SKIP
+      @cursor = cursor unless cursor == SKIP
+      @show_archived = show_archived unless show_archived == SKIP
+      @redemption_code = redemption_code unless redemption_code == 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.
+      limit = hash['limit'] ||= 20
+      cursor = hash.key?('cursor') ? hash['cursor'] : SKIP
+      show_archived = hash.key?('show_archived') ? hash['show_archived'] : SKIP
+      redemption_code =
+        hash.key?('redemption_code') ? hash['redemption_code'] : SKIP
+
+      # Create object from extracted values.
+      CouponQueryParams.new(limit: limit,
+                            cursor: cursor,
+                            show_archived: show_archived,
+                            redemption_code: redemption_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} limit: #{@limit}, cursor: #{@cursor}, show_archived: #{@show_archived},"\
+      " redemption_code: #{@redemption_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} limit: #{@limit.inspect}, cursor: #{@cursor.inspect}, show_archived:"\
+      " #{@show_archived.inspect}, redemption_code: #{@redemption_code.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/coupon_redemption.rb

@@ -0,0 +1,132 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # CouponRedemption Model.
+  class CouponRedemption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :coupon_id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['coupon_id'] = 'coupon_id'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+      ]
+    end
+
+    def initialize(coupon_id:, start_date:, end_date:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @coupon_id = coupon_id
+      @start_date = start_date
+      @end_date = end_date
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      coupon_id = hash.key?('coupon_id') ? hash['coupon_id'] : nil
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   end
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CouponRedemption.new(coupon_id: coupon_id,
+                           start_date: start_date,
+                           end_date: end_date,
+                           additional_properties: additional_properties)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CouponRedemption | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.coupon_id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.start_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.end_date,
+                                  ->(val) { val.instance_of? DateTime })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['coupon_id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['start_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['end_date'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} coupon_id: #{@coupon_id}, start_date: #{@start_date}, end_date:"\
+      " #{@end_date}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} coupon_id: #{@coupon_id.inspect}, start_date: #{@start_date.inspect},"\
+      " end_date: #{@end_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/coupons.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Coupons Model.
+  class Coupons < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Coupon]]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [PaginationMetadata]
+    attr_accessor :pagination_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['pagination_metadata'] = 'pagination_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, pagination_metadata:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @pagination_metadata = pagination_metadata
+      @additional_properties = additional_properties
+    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
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (Coupon.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+      pagination_metadata = PaginationMetadata.from_hash(hash['pagination_metadata']) if
+        hash['pagination_metadata']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Coupons.new(data: data,
+                  pagination_metadata: pagination_metadata,
+                  additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}, pagination_metadata: #{@pagination_metadata},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}, pagination_metadata:"\
+      " #{@pagination_metadata.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/create_credit_note_params.rb

@@ -0,0 +1,120 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreateCreditNoteParams Model.
+  class CreateCreditNoteParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CreditNoteLineItemParams]]
+    attr_accessor :line_items
+
+    # An optional reason for the credit note.
+    # @return [Reason1]
+    attr_accessor :reason
+
+    # An optional memo to attach to the credit note.
+    # @return [String]
+    attr_accessor :memo
+
+    # A date string to specify the global credit note service period start date
+    # in the customer's timezone. This will be applied to all line items that
+    # don't have their own individual service periods specified. If not
+    # provided, line items will use their original invoice line item service
+    # periods. This date is inclusive.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # A date string to specify the global credit note service period end date in
+    # the customer's timezone. This will be applied to all line items that don't
+    # have their own individual service periods specified. If not provided, line
+    # items will use their original invoice line item service periods. This date
+    # is inclusive.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line_items'] = 'line_items'
+      @_hash['reason'] = 'reason'
+      @_hash['memo'] = 'memo'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        memo
+        start_date
+        end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        memo
+        start_date
+        end_date
+      ]
+    end
+
+    def initialize(line_items:, reason:, memo: SKIP, start_date: SKIP,
+                   end_date: SKIP)
+      @line_items = line_items
+      @reason = reason
+      @memo = memo unless memo == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == 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 << (CreditNoteLineItemParams.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('line_items')
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+
+      # Create object from extracted values.
+      CreateCreditNoteParams.new(line_items: line_items,
+                                 reason: reason,
+                                 memo: memo,
+                                 start_date: start_date,
+                                 end_date: end_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line_items: #{@line_items}, reason: #{@reason}, memo: #{@memo}, start_date:"\
+      " #{@start_date}, end_date: #{@end_date}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line_items: #{@line_items.inspect}, reason: #{@reason.inspect}, memo:"\
+      " #{@memo.inspect}, start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/create_customer_alert_request_params.rb

@@ -0,0 +1,91 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreateCustomerAlertRequestParams Model.
+  class CreateCustomerAlertRequestParams < 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
+
+    # The type of alert to create. This must be a valid alert type.
+    # @return [Type6]
+    attr_accessor :type
+
+    # The case sensitive currency or custom pricing unit to use for this alert.
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['thresholds'] = 'thresholds'
+      @_hash['type'] = 'type'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        thresholds
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        thresholds
+      ]
+    end
+
+    def initialize(type:, currency:, thresholds: SKIP)
+      @thresholds = thresholds unless thresholds == SKIP
+      @type = type
+      @currency = currency
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      type = hash.key?('type') ? hash['type'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      # 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 = SKIP unless hash.key?('thresholds')
+
+      # Create object from extracted values.
+      CreateCustomerAlertRequestParams.new(type: type,
+                                           currency: currency,
+                                           thresholds: thresholds)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} thresholds: #{@thresholds}, type: #{@type}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} thresholds: #{@thresholds.inspect}, type: #{@type.inspect}, currency:"\
+      " #{@currency.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/create_invoice_line_item_params.rb

@@ -0,0 +1,128 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreateInvoiceLineItemParams Model.
+  class CreateInvoiceLineItemParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A date string to specify the line item's start date in the customer's
+    # timezone.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # A date string to specify the line item's end date in the customer's
+    # timezone.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The number of units on the line item
+    # @return [Float]
+    attr_accessor :quantity
+
+    # The id of the Invoice to add this line item.
+    # @return [String]
+    attr_accessor :invoice_id
+
+    # The name to use for the line item. If `item_id` is not provided, Orb will
+    # search for an item with this name. If found, that item will be associated
+    # with the line item. If not found, a new item will be created with this
+    # name. If `item_id` is provided, this name will be used for the line item,
+    # but the item association will be based on `item_id`. At least one of
+    # `name` or `item_id` must be provided.
+    # @return [String]
+    attr_accessor :name
+
+    # The total amount in the invoice's currency to add to the line item.
+    # @return [String]
+    attr_accessor :amount
+
+    # The id of the item to associate with this line item. If provided without
+    # `name`, the item's name will be used for the price/line item. If provided
+    # with `name`, the item will be associated but `name` will be used for the
+    # line item. At least one of `name` or `item_id` must be provided.
+    # @return [String]
+    attr_accessor :item_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['quantity'] = 'quantity'
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['name'] = 'name'
+      @_hash['amount'] = 'amount'
+      @_hash['item_id'] = 'item_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        item_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        name
+        item_id
+      ]
+    end
+
+    def initialize(start_date:, end_date:, quantity:, invoice_id:, amount:,
+                   name: SKIP, item_id: SKIP)
+      @start_date = start_date
+      @end_date = end_date
+      @quantity = quantity
+      @invoice_id = invoice_id
+      @name = name unless name == SKIP
+      @amount = amount
+      @item_id = item_id unless item_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.
+      start_date = hash.key?('start_date') ? hash['start_date'] : nil
+      end_date = hash.key?('end_date') ? hash['end_date'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      name = hash.key?('name') ? hash['name'] : SKIP
+      item_id = hash.key?('item_id') ? hash['item_id'] : SKIP
+
+      # Create object from extracted values.
+      CreateInvoiceLineItemParams.new(start_date: start_date,
+                                      end_date: end_date,
+                                      quantity: quantity,
+                                      invoice_id: invoice_id,
+                                      amount: amount,
+                                      name: name,
+                                      item_id: item_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date}, end_date: #{@end_date}, quantity: #{@quantity},"\
+      " invoice_id: #{@invoice_id}, name: #{@name}, amount: #{@amount}, item_id: #{@item_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " quantity: #{@quantity.inspect}, invoice_id: #{@invoice_id.inspect}, name:"\
+      " #{@name.inspect}, amount: #{@amount.inspect}, item_id: #{@item_id.inspect}>"
+    end
+  end
+end