orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/list_invoices_params.rb

@@ -0,0 +1,345 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # ListInvoicesParams Model.
+  class ListInvoicesParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :customer_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :external_customer_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # TODO: Write general description for this method
+    # @return [Status1]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [Array[Status11]]
+    attr_accessor :status_1
+
+    # Filters invoices by their due dates within a specific time range in the
+    # past. Specify the range as a number followed by 'd' (days) or 'm'
+    # (months). For example, '7d' filters invoices due in the last 7 days, and
+    # '2m' filters those due in the last 2 months.
+    # @return [String]
+    attr_accessor :due_date_window
+
+    # Filters invoices by their due dates within a specific time range in the
+    # past. Specify the range as a number followed by 'd' (days) or 'm'
+    # (months). For example, '7d' filters invoices due in the last 7 days, and
+    # '2m' filters those due in the last 2 months.
+    # @return [DateType]
+    attr_accessor :date_type
+
+    # Filters invoices by their due dates within a specific time range in the
+    # past. Specify the range as a number followed by 'd' (days) or 'm'
+    # (months). For example, '7d' filters invoices due in the last 7 days, and
+    # '2m' filters those due in the last 2 months.
+    # @return [Date]
+    attr_accessor :due_date
+
+    # Filters invoices by their due dates within a specific time range in the
+    # past. Specify the range as a number followed by 'd' (days) or 'm'
+    # (months). For example, '7d' filters invoices due in the last 7 days, and
+    # '2m' filters those due in the last 2 months.
+    # @return [Date]
+    attr_accessor :due_date_gt
+
+    # Filters invoices by their due dates within a specific time range in the
+    # past. Specify the range as a number followed by 'd' (days) or 'm'
+    # (months). For example, '7d' filters invoices due in the last 7 days, and
+    # '2m' filters those due in the last 2 months.
+    # @return [Date]
+    attr_accessor :due_date_lt
+
+    # Filters invoices by their due dates within a specific time range in the
+    # past. Specify the range as a number followed by 'd' (days) or 'm'
+    # (months). For example, '7d' filters invoices due in the last 7 days, and
+    # '2m' filters those due in the last 2 months.
+    # @return [String]
+    attr_accessor :amount
+
+    # Filters invoices by their due dates within a specific time range in the
+    # past. Specify the range as a number followed by 'd' (days) or 'm'
+    # (months). For example, '7d' filters invoices due in the last 7 days, and
+    # '2m' filters those due in the last 2 months.
+    # @return [String]
+    attr_accessor :amount_gt
+
+    # Filters invoices by their due dates within a specific time range in the
+    # past. Specify the range as a number followed by 'd' (days) or 'm'
+    # (months). For example, '7d' filters invoices due in the last 7 days, and
+    # '2m' filters those due in the last 2 months.
+    # @return [String]
+    attr_accessor :amount_lt
+
+    # Filters invoices by their due dates within a specific time range in the
+    # past. Specify the range as a number followed by 'd' (days) or 'm'
+    # (months). For example, '7d' filters invoices due in the last 7 days, and
+    # '2m' filters those due in the last 2 months.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_recurring
+
+    # 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 :invoice_date_gte
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [DateTime]
+    attr_accessor :invoice_date_gt
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [DateTime]
+    attr_accessor :invoice_date_lt
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [DateTime]
+    attr_accessor :invoice_date_lte
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['external_customer_id'] = 'external_customer_id'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['status'] = 'status'
+      @_hash['status_1'] = 'status_1'
+      @_hash['due_date_window'] = 'due_date_window'
+      @_hash['date_type'] = 'date_type'
+      @_hash['due_date'] = 'due_date'
+      @_hash['due_date_gt'] = 'due_date[gt]'
+      @_hash['due_date_lt'] = 'due_date[lt]'
+      @_hash['amount'] = 'amount'
+      @_hash['amount_gt'] = 'amount[gt]'
+      @_hash['amount_lt'] = 'amount[lt]'
+      @_hash['is_recurring'] = 'is_recurring'
+      @_hash['limit'] = 'limit'
+      @_hash['cursor'] = 'cursor'
+      @_hash['invoice_date_gte'] = 'invoice_date[gte]'
+      @_hash['invoice_date_gt'] = 'invoice_date[gt]'
+      @_hash['invoice_date_lt'] = 'invoice_date[lt]'
+      @_hash['invoice_date_lte'] = 'invoice_date[lte]'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_id
+        external_customer_id
+        subscription_id
+        status
+        status_1
+        due_date_window
+        date_type
+        due_date
+        due_date_gt
+        due_date_lt
+        amount
+        amount_gt
+        amount_lt
+        is_recurring
+        limit
+        cursor
+        invoice_date_gte
+        invoice_date_gt
+        invoice_date_lt
+        invoice_date_lte
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        customer_id
+        external_customer_id
+        subscription_id
+        status
+        status_1
+        due_date_window
+        date_type
+        due_date
+        due_date_gt
+        due_date_lt
+        amount
+        amount_gt
+        amount_lt
+        is_recurring
+        cursor
+        invoice_date_gte
+        invoice_date_gt
+        invoice_date_lt
+        invoice_date_lte
+      ]
+    end
+
+    def initialize(customer_id: SKIP, external_customer_id: SKIP,
+                   subscription_id: SKIP, status: SKIP, status_1: SKIP,
+                   due_date_window: SKIP, date_type: DateType::INVOICE_DATE,
+                   due_date: SKIP, due_date_gt: SKIP, due_date_lt: SKIP,
+                   amount: SKIP, amount_gt: SKIP, amount_lt: SKIP,
+                   is_recurring: SKIP, limit: 20, cursor: SKIP,
+                   invoice_date_gte: SKIP, invoice_date_gt: SKIP,
+                   invoice_date_lt: SKIP, invoice_date_lte: SKIP)
+      @customer_id = customer_id unless customer_id == SKIP
+      @external_customer_id = external_customer_id unless external_customer_id == SKIP
+      @subscription_id = subscription_id unless subscription_id == SKIP
+      @status = status unless status == SKIP
+      @status_1 = status_1 unless status_1 == SKIP
+      @due_date_window = due_date_window unless due_date_window == SKIP
+      @date_type = date_type unless date_type == SKIP
+      @due_date = due_date unless due_date == SKIP
+      @due_date_gt = due_date_gt unless due_date_gt == SKIP
+      @due_date_lt = due_date_lt unless due_date_lt == SKIP
+      @amount = amount unless amount == SKIP
+      @amount_gt = amount_gt unless amount_gt == SKIP
+      @amount_lt = amount_lt unless amount_lt == SKIP
+      @is_recurring = is_recurring unless is_recurring == SKIP
+      @limit = limit unless limit == SKIP
+      @cursor = cursor unless cursor == SKIP
+      @invoice_date_gte = invoice_date_gte unless invoice_date_gte == SKIP
+      @invoice_date_gt = invoice_date_gt unless invoice_date_gt == SKIP
+      @invoice_date_lt = invoice_date_lt unless invoice_date_lt == SKIP
+      @invoice_date_lte = invoice_date_lte unless invoice_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.
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      external_customer_id =
+        hash.key?('external_customer_id') ? hash['external_customer_id'] : SKIP
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_1 = hash.key?('status_1') ? hash['status_1'] : SKIP
+      due_date_window =
+        hash.key?('due_date_window') ? hash['due_date_window'] : SKIP
+      date_type = hash['date_type'] ||= DateType::INVOICE_DATE
+      due_date = hash.key?('due_date') ? hash['due_date'] : SKIP
+      due_date_gt = hash.key?('due_date[gt]') ? hash['due_date[gt]'] : SKIP
+      due_date_lt = hash.key?('due_date[lt]') ? hash['due_date[lt]'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      amount_gt = hash.key?('amount[gt]') ? hash['amount[gt]'] : SKIP
+      amount_lt = hash.key?('amount[lt]') ? hash['amount[lt]'] : SKIP
+      is_recurring = hash.key?('is_recurring') ? hash['is_recurring'] : SKIP
+      limit = hash['limit'] ||= 20
+      cursor = hash.key?('cursor') ? hash['cursor'] : SKIP
+      invoice_date_gte = if hash.key?('invoice_date[gte]')
+                           (DateTimeHelper.from_rfc3339(hash['invoice_date[gte]']) if hash['invoice_date[gte]'])
+                         else
+                           SKIP
+                         end
+      invoice_date_gt = if hash.key?('invoice_date[gt]')
+                          (DateTimeHelper.from_rfc3339(hash['invoice_date[gt]']) if hash['invoice_date[gt]'])
+                        else
+                          SKIP
+                        end
+      invoice_date_lt = if hash.key?('invoice_date[lt]')
+                          (DateTimeHelper.from_rfc3339(hash['invoice_date[lt]']) if hash['invoice_date[lt]'])
+                        else
+                          SKIP
+                        end
+      invoice_date_lte = if hash.key?('invoice_date[lte]')
+                           (DateTimeHelper.from_rfc3339(hash['invoice_date[lte]']) if hash['invoice_date[lte]'])
+                         else
+                           SKIP
+                         end
+
+      # Create object from extracted values.
+      ListInvoicesParams.new(customer_id: customer_id,
+                             external_customer_id: external_customer_id,
+                             subscription_id: subscription_id,
+                             status: status,
+                             status_1: status_1,
+                             due_date_window: due_date_window,
+                             date_type: date_type,
+                             due_date: due_date,
+                             due_date_gt: due_date_gt,
+                             due_date_lt: due_date_lt,
+                             amount: amount,
+                             amount_gt: amount_gt,
+                             amount_lt: amount_lt,
+                             is_recurring: is_recurring,
+                             limit: limit,
+                             cursor: cursor,
+                             invoice_date_gte: invoice_date_gte,
+                             invoice_date_gt: invoice_date_gt,
+                             invoice_date_lt: invoice_date_lt,
+                             invoice_date_lte: invoice_date_lte)
+    end
+
+    def to_custom_invoice_date_gte
+      DateTimeHelper.to_rfc3339(invoice_date_gte)
+    end
+
+    def to_custom_invoice_date_gt
+      DateTimeHelper.to_rfc3339(invoice_date_gt)
+    end
+
+    def to_custom_invoice_date_lt
+      DateTimeHelper.to_rfc3339(invoice_date_lt)
+    end
+
+    def to_custom_invoice_date_lte
+      DateTimeHelper.to_rfc3339(invoice_date_lte)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_id: #{@customer_id}, external_customer_id:"\
+      " #{@external_customer_id}, subscription_id: #{@subscription_id}, status: #{@status},"\
+      " status_1: #{@status_1}, due_date_window: #{@due_date_window}, date_type: #{@date_type},"\
+      " due_date: #{@due_date}, due_date_gt: #{@due_date_gt}, due_date_lt: #{@due_date_lt},"\
+      " amount: #{@amount}, amount_gt: #{@amount_gt}, amount_lt: #{@amount_lt}, is_recurring:"\
+      " #{@is_recurring}, limit: #{@limit}, cursor: #{@cursor}, invoice_date_gte:"\
+      " #{@invoice_date_gte}, invoice_date_gt: #{@invoice_date_gt}, invoice_date_lt:"\
+      " #{@invoice_date_lt}, invoice_date_lte: #{@invoice_date_lte}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_id: #{@customer_id.inspect}, external_customer_id:"\
+      " #{@external_customer_id.inspect}, subscription_id: #{@subscription_id.inspect}, status:"\
+      " #{@status.inspect}, status_1: #{@status_1.inspect}, due_date_window:"\
+      " #{@due_date_window.inspect}, date_type: #{@date_type.inspect}, due_date:"\
+      " #{@due_date.inspect}, due_date_gt: #{@due_date_gt.inspect}, due_date_lt:"\
+      " #{@due_date_lt.inspect}, amount: #{@amount.inspect}, amount_gt: #{@amount_gt.inspect},"\
+      " amount_lt: #{@amount_lt.inspect}, is_recurring: #{@is_recurring.inspect}, limit:"\
+      " #{@limit.inspect}, cursor: #{@cursor.inspect}, invoice_date_gte:"\
+      " #{@invoice_date_gte.inspect}, invoice_date_gt: #{@invoice_date_gt.inspect},"\
+      " invoice_date_lt: #{@invoice_date_lt.inspect}, invoice_date_lte:"\
+      " #{@invoice_date_lte.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/list_licenses_params.rb

@@ -0,0 +1,125 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ListLicensesParams Model.
+  class ListLicensesParams < 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 [String]
+    attr_accessor :subscription_id
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [String]
+    attr_accessor :license_type_id
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [String]
+    attr_accessor :external_license_id
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [Status7]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['limit'] = 'limit'
+      @_hash['cursor'] = 'cursor'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['license_type_id'] = 'license_type_id'
+      @_hash['external_license_id'] = 'external_license_id'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        limit
+        cursor
+        license_type_id
+        external_license_id
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cursor
+        license_type_id
+        external_license_id
+        status
+      ]
+    end
+
+    def initialize(subscription_id:, limit: 20, cursor: SKIP,
+                   license_type_id: SKIP, external_license_id: SKIP,
+                   status: SKIP)
+      @limit = limit unless limit == SKIP
+      @cursor = cursor unless cursor == SKIP
+      @subscription_id = subscription_id
+      @license_type_id = license_type_id unless license_type_id == SKIP
+      @external_license_id = external_license_id unless external_license_id == SKIP
+      @status = status unless status == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : nil
+      limit = hash['limit'] ||= 20
+      cursor = hash.key?('cursor') ? hash['cursor'] : SKIP
+      license_type_id =
+        hash.key?('license_type_id') ? hash['license_type_id'] : SKIP
+      external_license_id =
+        hash.key?('external_license_id') ? hash['external_license_id'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      ListLicensesParams.new(subscription_id: subscription_id,
+                             limit: limit,
+                             cursor: cursor,
+                             license_type_id: license_type_id,
+                             external_license_id: external_license_id,
+                             status: status)
+    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}, subscription_id: #{@subscription_id},"\
+      " license_type_id: #{@license_type_id}, external_license_id: #{@external_license_id},"\
+      " status: #{@status}>"
+    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}, subscription_id:"\
+      " #{@subscription_id.inspect}, license_type_id: #{@license_type_id.inspect},"\
+      " external_license_id: #{@external_license_id.inspect}, status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/list_metrics_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
+  # ListMetricsQueryParams Model.
+  class ListMetricsQueryParams < 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 :created_at_gte
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [DateTime]
+    attr_accessor :created_at_gt
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [DateTime]
+    attr_accessor :created_at_lt
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @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['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
+        created_at_gte
+        created_at_gt
+        created_at_lt
+        created_at_lte
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cursor
+        created_at_gte
+        created_at_gt
+        created_at_lt
+        created_at_lte
+      ]
+    end
+
+    def initialize(limit: 20, cursor: 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
+      @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
+      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.
+      ListMetricsQueryParams.new(limit: limit,
+                                 cursor: cursor,
+                                 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}, 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}, 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