orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/fetch_customer_credit_blocks_query_params.rb

@@ -0,0 +1,181 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # FetchCustomerCreditBlocksQueryParams Model.
+  class FetchCustomerCreditBlocksQueryParams < 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
+
+    # The ledger currency or custom pricing unit to use.
+    # @return [String]
+    attr_accessor :currency
+
+    # If set to True, all expired and depleted blocks, as well as active block
+    # will be returned.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_all_blocks
+
+    # If set to True, all expired and depleted blocks, as well as active block
+    # will be returned.
+    # @return [DateTime]
+    attr_accessor :effective_date_gte
+
+    # If set to True, all expired and depleted blocks, as well as active block
+    # will be returned.
+    # @return [DateTime]
+    attr_accessor :effective_date_gt
+
+    # If set to True, all expired and depleted blocks, as well as active block
+    # will be returned.
+    # @return [DateTime]
+    attr_accessor :effective_date_lt
+
+    # If set to True, all expired and depleted blocks, as well as active block
+    # will be returned.
+    # @return [DateTime]
+    attr_accessor :effective_date_lte
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['limit'] = 'limit'
+      @_hash['cursor'] = 'cursor'
+      @_hash['currency'] = 'currency'
+      @_hash['include_all_blocks'] = 'include_all_blocks'
+      @_hash['effective_date_gte'] = 'effective_date[gte]'
+      @_hash['effective_date_gt'] = 'effective_date[gt]'
+      @_hash['effective_date_lt'] = 'effective_date[lt]'
+      @_hash['effective_date_lte'] = 'effective_date[lte]'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        limit
+        cursor
+        currency
+        include_all_blocks
+        effective_date_gte
+        effective_date_gt
+        effective_date_lt
+        effective_date_lte
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cursor
+        currency
+        effective_date_gte
+        effective_date_gt
+        effective_date_lt
+        effective_date_lte
+      ]
+    end
+
+    def initialize(limit: 20, cursor: SKIP, currency: SKIP,
+                   include_all_blocks: false, effective_date_gte: SKIP,
+                   effective_date_gt: SKIP, effective_date_lt: SKIP,
+                   effective_date_lte: SKIP)
+      @limit = limit unless limit == SKIP
+      @cursor = cursor unless cursor == SKIP
+      @currency = currency unless currency == SKIP
+      @include_all_blocks = include_all_blocks unless include_all_blocks == SKIP
+      @effective_date_gte = effective_date_gte unless effective_date_gte == SKIP
+      @effective_date_gt = effective_date_gt unless effective_date_gt == SKIP
+      @effective_date_lt = effective_date_lt unless effective_date_lt == SKIP
+      @effective_date_lte = effective_date_lte unless effective_date_lte == 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
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      include_all_blocks = hash['include_all_blocks'] ||= false
+      effective_date_gte = if hash.key?('effective_date[gte]')
+                             (DateTimeHelper.from_rfc3339(hash['effective_date[gte]']) if hash['effective_date[gte]'])
+                           else
+                             SKIP
+                           end
+      effective_date_gt = if hash.key?('effective_date[gt]')
+                            (DateTimeHelper.from_rfc3339(hash['effective_date[gt]']) if hash['effective_date[gt]'])
+                          else
+                            SKIP
+                          end
+      effective_date_lt = if hash.key?('effective_date[lt]')
+                            (DateTimeHelper.from_rfc3339(hash['effective_date[lt]']) if hash['effective_date[lt]'])
+                          else
+                            SKIP
+                          end
+      effective_date_lte = if hash.key?('effective_date[lte]')
+                             (DateTimeHelper.from_rfc3339(hash['effective_date[lte]']) if hash['effective_date[lte]'])
+                           else
+                             SKIP
+                           end
+
+      # Create object from extracted values.
+      FetchCustomerCreditBlocksQueryParams.new(limit: limit,
+                                               cursor: cursor,
+                                               currency: currency,
+                                               include_all_blocks: include_all_blocks,
+                                               effective_date_gte: effective_date_gte,
+                                               effective_date_gt: effective_date_gt,
+                                               effective_date_lt: effective_date_lt,
+                                               effective_date_lte: effective_date_lte)
+    end
+
+    def to_custom_effective_date_gte
+      DateTimeHelper.to_rfc3339(effective_date_gte)
+    end
+
+    def to_custom_effective_date_gt
+      DateTimeHelper.to_rfc3339(effective_date_gt)
+    end
+
+    def to_custom_effective_date_lt
+      DateTimeHelper.to_rfc3339(effective_date_lt)
+    end
+
+    def to_custom_effective_date_lte
+      DateTimeHelper.to_rfc3339(effective_date_lte)
+    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}, currency: #{@currency},"\
+      " include_all_blocks: #{@include_all_blocks}, effective_date_gte: #{@effective_date_gte},"\
+      " effective_date_gt: #{@effective_date_gt}, effective_date_lt: #{@effective_date_lt},"\
+      " effective_date_lte: #{@effective_date_lte}>"
+    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}, currency:"\
+      " #{@currency.inspect}, include_all_blocks: #{@include_all_blocks.inspect},"\
+      " effective_date_gte: #{@effective_date_gte.inspect}, effective_date_gt:"\
+      " #{@effective_date_gt.inspect}, effective_date_lt: #{@effective_date_lt.inspect},"\
+      " effective_date_lte: #{@effective_date_lte.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/fetch_customer_credit_ledger_query_params.rb

@@ -0,0 +1,198 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # FetchCustomerCreditLedgerQueryParams Model.
+  class FetchCustomerCreditLedgerQueryParams < 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
+
+    # The ledger currency or custom pricing unit to use.
+    # @return [String]
+    attr_accessor :currency
+
+    # The ledger currency or custom pricing unit to use.
+    # @return [String]
+    attr_accessor :minimum_amount
+
+    # The ledger currency or custom pricing unit to use.
+    # @return [EntryType]
+    attr_accessor :entry_type
+
+    # The ledger currency or custom pricing unit to use.
+    # @return [EntryStatus]
+    attr_accessor :entry_status
+
+    # The ledger currency or custom pricing unit to use.
+    # @return [DateTime]
+    attr_accessor :created_at_gte
+
+    # The ledger currency or custom pricing unit to use.
+    # @return [DateTime]
+    attr_accessor :created_at_gt
+
+    # The ledger currency or custom pricing unit to use.
+    # @return [DateTime]
+    attr_accessor :created_at_lt
+
+    # The ledger currency or custom pricing unit to use.
+    # @return [DateTime]
+    attr_accessor :created_at_lte
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['limit'] = 'limit'
+      @_hash['cursor'] = 'cursor'
+      @_hash['currency'] = 'currency'
+      @_hash['minimum_amount'] = 'minimum_amount'
+      @_hash['entry_type'] = 'entry_type'
+      @_hash['entry_status'] = 'entry_status'
+      @_hash['created_at_gte'] = 'created_at[gte]'
+      @_hash['created_at_gt'] = 'created_at[gt]'
+      @_hash['created_at_lt'] = 'created_at[lt]'
+      @_hash['created_at_lte'] = 'created_at[lte]'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        limit
+        cursor
+        currency
+        minimum_amount
+        entry_type
+        entry_status
+        created_at_gte
+        created_at_gt
+        created_at_lt
+        created_at_lte
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cursor
+        currency
+        minimum_amount
+        entry_type
+        entry_status
+        created_at_gte
+        created_at_gt
+        created_at_lt
+        created_at_lte
+      ]
+    end
+
+    def initialize(limit: 20, cursor: SKIP, currency: SKIP,
+                   minimum_amount: SKIP, entry_type: SKIP, entry_status: SKIP,
+                   created_at_gte: SKIP, created_at_gt: SKIP,
+                   created_at_lt: SKIP, created_at_lte: SKIP)
+      @limit = limit unless limit == SKIP
+      @cursor = cursor unless cursor == SKIP
+      @currency = currency unless currency == SKIP
+      @minimum_amount = minimum_amount unless minimum_amount == SKIP
+      @entry_type = entry_type unless entry_type == SKIP
+      @entry_status = entry_status unless entry_status == SKIP
+      @created_at_gte = created_at_gte unless created_at_gte == SKIP
+      @created_at_gt = created_at_gt unless created_at_gt == SKIP
+      @created_at_lt = created_at_lt unless created_at_lt == SKIP
+      @created_at_lte = created_at_lte unless created_at_lte == 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
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      minimum_amount =
+        hash.key?('minimum_amount') ? hash['minimum_amount'] : SKIP
+      entry_type = hash.key?('entry_type') ? hash['entry_type'] : SKIP
+      entry_status = hash.key?('entry_status') ? hash['entry_status'] : SKIP
+      created_at_gte = if hash.key?('created_at[gte]')
+                         (DateTimeHelper.from_rfc3339(hash['created_at[gte]']) if hash['created_at[gte]'])
+                       else
+                         SKIP
+                       end
+      created_at_gt = if hash.key?('created_at[gt]')
+                        (DateTimeHelper.from_rfc3339(hash['created_at[gt]']) if hash['created_at[gt]'])
+                      else
+                        SKIP
+                      end
+      created_at_lt = if hash.key?('created_at[lt]')
+                        (DateTimeHelper.from_rfc3339(hash['created_at[lt]']) if hash['created_at[lt]'])
+                      else
+                        SKIP
+                      end
+      created_at_lte = if hash.key?('created_at[lte]')
+                         (DateTimeHelper.from_rfc3339(hash['created_at[lte]']) if hash['created_at[lte]'])
+                       else
+                         SKIP
+                       end
+
+      # Create object from extracted values.
+      FetchCustomerCreditLedgerQueryParams.new(limit: limit,
+                                               cursor: cursor,
+                                               currency: currency,
+                                               minimum_amount: minimum_amount,
+                                               entry_type: entry_type,
+                                               entry_status: entry_status,
+                                               created_at_gte: created_at_gte,
+                                               created_at_gt: created_at_gt,
+                                               created_at_lt: created_at_lt,
+                                               created_at_lte: created_at_lte)
+    end
+
+    def to_custom_created_at_gte
+      DateTimeHelper.to_rfc3339(created_at_gte)
+    end
+
+    def to_custom_created_at_gt
+      DateTimeHelper.to_rfc3339(created_at_gt)
+    end
+
+    def to_custom_created_at_lt
+      DateTimeHelper.to_rfc3339(created_at_lt)
+    end
+
+    def to_custom_created_at_lte
+      DateTimeHelper.to_rfc3339(created_at_lte)
+    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}, currency: #{@currency},"\
+      " minimum_amount: #{@minimum_amount}, entry_type: #{@entry_type}, entry_status:"\
+      " #{@entry_status}, created_at_gte: #{@created_at_gte}, created_at_gt: #{@created_at_gt},"\
+      " created_at_lt: #{@created_at_lt}, created_at_lte: #{@created_at_lte}>"
+    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}, currency:"\
+      " #{@currency.inspect}, minimum_amount: #{@minimum_amount.inspect}, entry_type:"\
+      " #{@entry_type.inspect}, entry_status: #{@entry_status.inspect}, created_at_gte:"\
+      " #{@created_at_gte.inspect}, created_at_gt: #{@created_at_gt.inspect}, created_at_lt:"\
+      " #{@created_at_lt.inspect}, created_at_lte: #{@created_at_lte.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/fetch_license_by_external_id.rb

@@ -0,0 +1,72 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # FetchLicenseByExternalId Model.
+  class FetchLicenseByExternalId < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the subscription to fetch the license for.
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # The ID of the license type to fetch the license for.
+    # @return [String]
+    attr_accessor :license_type_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['license_type_id'] = 'license_type_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscription_id:, license_type_id:)
+      @subscription_id = subscription_id
+      @license_type_id = license_type_id
+    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'] : nil
+      license_type_id =
+        hash.key?('license_type_id') ? hash['license_type_id'] : nil
+
+      # Create object from extracted values.
+      FetchLicenseByExternalId.new(subscription_id: subscription_id,
+                                   license_type_id: license_type_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}, license_type_id:"\
+      " #{@license_type_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}, license_type_id:"\
+      " #{@license_type_id.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/fetch_subscription_schedule_query_params.rb

@@ -0,0 +1,157 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # FetchSubscriptionScheduleQueryParams Model.
+  class FetchSubscriptionScheduleQueryParams < 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
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [DateTime]
+    attr_accessor :start_date_gte
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [DateTime]
+    attr_accessor :start_date_gt
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [DateTime]
+    attr_accessor :start_date_lt
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [DateTime]
+    attr_accessor :start_date_lte
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['limit'] = 'limit'
+      @_hash['cursor'] = 'cursor'
+      @_hash['start_date_gte'] = 'start_date[gte]'
+      @_hash['start_date_gt'] = 'start_date[gt]'
+      @_hash['start_date_lt'] = 'start_date[lt]'
+      @_hash['start_date_lte'] = 'start_date[lte]'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        limit
+        cursor
+        start_date_gte
+        start_date_gt
+        start_date_lt
+        start_date_lte
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cursor
+        start_date_gte
+        start_date_gt
+        start_date_lt
+        start_date_lte
+      ]
+    end
+
+    def initialize(limit: 20, cursor: SKIP, start_date_gte: SKIP,
+                   start_date_gt: SKIP, start_date_lt: SKIP,
+                   start_date_lte: SKIP)
+      @limit = limit unless limit == SKIP
+      @cursor = cursor unless cursor == SKIP
+      @start_date_gte = start_date_gte unless start_date_gte == SKIP
+      @start_date_gt = start_date_gt unless start_date_gt == SKIP
+      @start_date_lt = start_date_lt unless start_date_lt == SKIP
+      @start_date_lte = start_date_lte unless start_date_lte == 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
+      start_date_gte = if hash.key?('start_date[gte]')
+                         (DateTimeHelper.from_rfc3339(hash['start_date[gte]']) if hash['start_date[gte]'])
+                       else
+                         SKIP
+                       end
+      start_date_gt = if hash.key?('start_date[gt]')
+                        (DateTimeHelper.from_rfc3339(hash['start_date[gt]']) if hash['start_date[gt]'])
+                      else
+                        SKIP
+                      end
+      start_date_lt = if hash.key?('start_date[lt]')
+                        (DateTimeHelper.from_rfc3339(hash['start_date[lt]']) if hash['start_date[lt]'])
+                      else
+                        SKIP
+                      end
+      start_date_lte = if hash.key?('start_date[lte]')
+                         (DateTimeHelper.from_rfc3339(hash['start_date[lte]']) if hash['start_date[lte]'])
+                       else
+                         SKIP
+                       end
+
+      # Create object from extracted values.
+      FetchSubscriptionScheduleQueryParams.new(limit: limit,
+                                               cursor: cursor,
+                                               start_date_gte: start_date_gte,
+                                               start_date_gt: start_date_gt,
+                                               start_date_lt: start_date_lt,
+                                               start_date_lte: start_date_lte)
+    end
+
+    def to_custom_start_date_gte
+      DateTimeHelper.to_rfc3339(start_date_gte)
+    end
+
+    def to_custom_start_date_gt
+      DateTimeHelper.to_rfc3339(start_date_gt)
+    end
+
+    def to_custom_start_date_lt
+      DateTimeHelper.to_rfc3339(start_date_lt)
+    end
+
+    def to_custom_start_date_lte
+      DateTimeHelper.to_rfc3339(start_date_lte)
+    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}, start_date_gte: #{@start_date_gte},"\
+      " start_date_gt: #{@start_date_gt}, start_date_lt: #{@start_date_lt}, start_date_lte:"\
+      " #{@start_date_lte}>"
+    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}, start_date_gte:"\
+      " #{@start_date_gte.inspect}, start_date_gt: #{@start_date_gt.inspect}, start_date_lt:"\
+      " #{@start_date_lt.inspect}, start_date_lte: #{@start_date_lte.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/fetch_upcoming_invoice_params.rb

@@ -0,0 +1,61 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # FetchUpcomingInvoiceParams Model.
+  class FetchUpcomingInvoiceParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscription_id:)
+      @subscription_id = subscription_id
+    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'] : nil
+
+      # Create object from extracted values.
+      FetchUpcomingInvoiceParams.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