orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/license_usage.rb

@@ -0,0 +1,203 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # The LicenseUsage resource represents usage and remaining credits for a
+  # license over a date range. When grouped by 'day' only, license_id and
+  # external_license_id will be null as the data is aggregated across all
+  # licenses.
+  class LicenseUsage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the license. Null when grouped by day only.
+    # @return [String]
+    attr_accessor :license_id
+
+    # The unique identifier for the subscription.
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # The unique identifier for the license type.
+    # @return [String]
+    attr_accessor :license_type_id
+
+    # The external identifier for the license. Null when grouped by day only.
+    # @return [String]
+    attr_accessor :external_license_id
+
+    # The start date of the usage period.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # The end date of the usage period.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The total credits allocated to this license for the period.
+    # @return [Float]
+    attr_accessor :allocated_credits
+
+    # The credits consumed by this license for the period.
+    # @return [Float]
+    attr_accessor :consumed_credits
+
+    # The remaining credits available for this license (allocated - consumed).
+    # @return [Float]
+    attr_accessor :remaining_credits
+
+    # The pricing unit for the credits (e.g., 'credits').
+    # @return [String]
+    attr_accessor :pricing_unit
+
+    # Credits consumed while the license was active (eligible for individual
+    # allocation deduction).
+    # @return [Float]
+    attr_accessor :allocation_eligible_credits
+
+    # Credits consumed while the license was inactive (draws from shared pool,
+    # not individual allocation).
+    # @return [Float]
+    attr_accessor :shared_pool_credits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['license_id'] = 'license_id'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['license_type_id'] = 'license_type_id'
+      @_hash['external_license_id'] = 'external_license_id'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['allocated_credits'] = 'allocated_credits'
+      @_hash['consumed_credits'] = 'consumed_credits'
+      @_hash['remaining_credits'] = 'remaining_credits'
+      @_hash['pricing_unit'] = 'pricing_unit'
+      @_hash['allocation_eligible_credits'] = 'allocation_eligible_credits'
+      @_hash['shared_pool_credits'] = 'shared_pool_credits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        license_id
+        external_license_id
+        allocation_eligible_credits
+        shared_pool_credits
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        license_id
+        external_license_id
+        allocation_eligible_credits
+        shared_pool_credits
+      ]
+    end
+
+    def initialize(subscription_id:, license_type_id:, start_date:, end_date:,
+                   allocated_credits:, consumed_credits:, remaining_credits:,
+                   pricing_unit:, license_id: SKIP, external_license_id: SKIP,
+                   allocation_eligible_credits: SKIP, shared_pool_credits: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @license_id = license_id unless license_id == SKIP
+      @subscription_id = subscription_id
+      @license_type_id = license_type_id
+      @external_license_id = external_license_id unless external_license_id == SKIP
+      @start_date = start_date
+      @end_date = end_date
+      @allocated_credits = allocated_credits
+      @consumed_credits = consumed_credits
+      @remaining_credits = remaining_credits
+      @pricing_unit = pricing_unit
+      unless allocation_eligible_credits == SKIP
+        @allocation_eligible_credits =
+          allocation_eligible_credits
+      end
+      @shared_pool_credits = shared_pool_credits unless shared_pool_credits == SKIP
+      @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.
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : nil
+      license_type_id =
+        hash.key?('license_type_id') ? hash['license_type_id'] : nil
+      start_date = hash.key?('start_date') ? hash['start_date'] : nil
+      end_date = hash.key?('end_date') ? hash['end_date'] : nil
+      allocated_credits =
+        hash.key?('allocated_credits') ? hash['allocated_credits'] : nil
+      consumed_credits =
+        hash.key?('consumed_credits') ? hash['consumed_credits'] : nil
+      remaining_credits =
+        hash.key?('remaining_credits') ? hash['remaining_credits'] : nil
+      pricing_unit = hash.key?('pricing_unit') ? hash['pricing_unit'] : nil
+      license_id = hash.key?('license_id') ? hash['license_id'] : SKIP
+      external_license_id =
+        hash.key?('external_license_id') ? hash['external_license_id'] : SKIP
+      allocation_eligible_credits =
+        hash.key?('allocation_eligible_credits') ? hash['allocation_eligible_credits'] : SKIP
+      shared_pool_credits =
+        hash.key?('shared_pool_credits') ? hash['shared_pool_credits'] : SKIP
+
+      # 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.
+      LicenseUsage.new(subscription_id: subscription_id,
+                       license_type_id: license_type_id,
+                       start_date: start_date,
+                       end_date: end_date,
+                       allocated_credits: allocated_credits,
+                       consumed_credits: consumed_credits,
+                       remaining_credits: remaining_credits,
+                       pricing_unit: pricing_unit,
+                       license_id: license_id,
+                       external_license_id: external_license_id,
+                       allocation_eligible_credits: allocation_eligible_credits,
+                       shared_pool_credits: shared_pool_credits,
+                       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} license_id: #{@license_id}, subscription_id: #{@subscription_id},"\
+      " license_type_id: #{@license_type_id}, external_license_id: #{@external_license_id},"\
+      " start_date: #{@start_date}, end_date: #{@end_date}, allocated_credits:"\
+      " #{@allocated_credits}, consumed_credits: #{@consumed_credits}, remaining_credits:"\
+      " #{@remaining_credits}, pricing_unit: #{@pricing_unit}, allocation_eligible_credits:"\
+      " #{@allocation_eligible_credits}, shared_pool_credits: #{@shared_pool_credits},"\
+      " 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} license_id: #{@license_id.inspect}, subscription_id:"\
+      " #{@subscription_id.inspect}, license_type_id: #{@license_type_id.inspect},"\
+      " external_license_id: #{@external_license_id.inspect}, start_date: #{@start_date.inspect},"\
+      " end_date: #{@end_date.inspect}, allocated_credits: #{@allocated_credits.inspect},"\
+      " consumed_credits: #{@consumed_credits.inspect}, remaining_credits:"\
+      " #{@remaining_credits.inspect}, pricing_unit: #{@pricing_unit.inspect},"\
+      " allocation_eligible_credits: #{@allocation_eligible_credits.inspect}, shared_pool_credits:"\
+      " #{@shared_pool_credits.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/license_usage_by_external_id_query_params.rb

@@ -0,0 +1,133 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Query parameters for GET
+  # /v1/licenses/external_licenses/<external_license_id>/usage The
+  # external_license_id is provided as a path parameter. Requires
+  # subscription_id to identify which subscription the license belongs to.
+  class LicenseUsageByExternalIdQueryParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Start date for the usage period (YYYY-MM-DD). Defaults to start of current
+    # billing period.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # End date for the usage period (YYYY-MM-DD). Defaults to end of current
+    # billing period.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # How to group the results. Valid values: 'license', 'day'. Can be combined
+    # (e.g., 'license,day').
+    # @return [String]
+    attr_accessor :group_by
+
+    # Pagination cursor from a previous request.
+    # @return [String]
+    attr_accessor :cursor
+
+    # Maximum number of rows in the response data (default 20, max 100).
+    # @return [Integer]
+    attr_accessor :limit
+
+    # The subscription ID to get license usage for.
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # The license type ID to filter licenses by.
+    # @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['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['group_by'] = 'group_by'
+      @_hash['cursor'] = 'cursor'
+      @_hash['limit'] = 'limit'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['license_type_id'] = 'license_type_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+        group_by
+        cursor
+        limit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        start_date
+        end_date
+        group_by
+        cursor
+      ]
+    end
+
+    def initialize(subscription_id:, license_type_id:, start_date: SKIP,
+                   end_date: SKIP, group_by: SKIP, cursor: SKIP, limit: 20)
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @group_by = group_by unless group_by == SKIP
+      @cursor = cursor unless cursor == SKIP
+      @limit = limit unless limit == SKIP
+      @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
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      group_by = hash.key?('group_by') ? hash['group_by'] : SKIP
+      cursor = hash.key?('cursor') ? hash['cursor'] : SKIP
+      limit = hash['limit'] ||= 20
+
+      # Create object from extracted values.
+      LicenseUsageByExternalIdQueryParams.new(subscription_id: subscription_id,
+                                              license_type_id: license_type_id,
+                                              start_date: start_date,
+                                              end_date: end_date,
+                                              group_by: group_by,
+                                              cursor: cursor,
+                                              limit: limit)
+    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}, group_by: #{@group_by},"\
+      " cursor: #{@cursor}, limit: #{@limit}, 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} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " group_by: #{@group_by.inspect}, cursor: #{@cursor.inspect}, limit: #{@limit.inspect},"\
+      " subscription_id: #{@subscription_id.inspect}, license_type_id:"\
+      " #{@license_type_id.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/license_usage_by_type_query_params.rb

@@ -0,0 +1,132 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Query parameters for GET /v1/licenses/usage Requires subscription_id and
+  # license_type_id to get usage for all licenses of a given type on a
+  # subscription.
+  class LicenseUsageByTypeQueryParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Start date for the usage period (YYYY-MM-DD). Defaults to start of current
+    # billing period.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # End date for the usage period (YYYY-MM-DD). Defaults to end of current
+    # billing period.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # How to group the results. Valid values: 'license', 'day'. Can be combined
+    # (e.g., 'license,day').
+    # @return [String]
+    attr_accessor :group_by
+
+    # Pagination cursor from a previous request.
+    # @return [String]
+    attr_accessor :cursor
+
+    # Maximum number of rows in the response data (default 20, max 100).
+    # @return [Integer]
+    attr_accessor :limit
+
+    # The subscription ID to get license usage for.
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # The license type ID to filter licenses by.
+    # @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['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['group_by'] = 'group_by'
+      @_hash['cursor'] = 'cursor'
+      @_hash['limit'] = 'limit'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['license_type_id'] = 'license_type_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+        group_by
+        cursor
+        limit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        start_date
+        end_date
+        group_by
+        cursor
+      ]
+    end
+
+    def initialize(subscription_id:, license_type_id:, start_date: SKIP,
+                   end_date: SKIP, group_by: SKIP, cursor: SKIP, limit: 20)
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @group_by = group_by unless group_by == SKIP
+      @cursor = cursor unless cursor == SKIP
+      @limit = limit unless limit == SKIP
+      @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
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      group_by = hash.key?('group_by') ? hash['group_by'] : SKIP
+      cursor = hash.key?('cursor') ? hash['cursor'] : SKIP
+      limit = hash['limit'] ||= 20
+
+      # Create object from extracted values.
+      LicenseUsageByTypeQueryParams.new(subscription_id: subscription_id,
+                                        license_type_id: license_type_id,
+                                        start_date: start_date,
+                                        end_date: end_date,
+                                        group_by: group_by,
+                                        cursor: cursor,
+                                        limit: limit)
+    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}, group_by: #{@group_by},"\
+      " cursor: #{@cursor}, limit: #{@limit}, 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} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " group_by: #{@group_by.inspect}, cursor: #{@cursor.inspect}, limit: #{@limit.inspect},"\
+      " subscription_id: #{@subscription_id.inspect}, license_type_id:"\
+      " #{@license_type_id.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/license_usage_query_params.rb

@@ -0,0 +1,110 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Base query parameters for license usage endpoints. Contains common
+  # parameters like date range, grouping, and pagination.
+  class LicenseUsageQueryParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Start date for the usage period (YYYY-MM-DD). Defaults to start of current
+    # billing period.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # End date for the usage period (YYYY-MM-DD). Defaults to end of current
+    # billing period.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # How to group the results. Valid values: 'license', 'day'. Can be combined
+    # (e.g., 'license,day').
+    # @return [String]
+    attr_accessor :group_by
+
+    # Pagination cursor from a previous request.
+    # @return [String]
+    attr_accessor :cursor
+
+    # Maximum number of rows in the response data (default 20, max 100).
+    # @return [Integer]
+    attr_accessor :limit
+
+    # 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['group_by'] = 'group_by'
+      @_hash['cursor'] = 'cursor'
+      @_hash['limit'] = 'limit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+        group_by
+        cursor
+        limit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        start_date
+        end_date
+        group_by
+        cursor
+      ]
+    end
+
+    def initialize(start_date: SKIP, end_date: SKIP, group_by: SKIP,
+                   cursor: SKIP, limit: 20)
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @group_by = group_by unless group_by == SKIP
+      @cursor = cursor unless cursor == SKIP
+      @limit = limit unless limit == 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'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      group_by = hash.key?('group_by') ? hash['group_by'] : SKIP
+      cursor = hash.key?('cursor') ? hash['cursor'] : SKIP
+      limit = hash['limit'] ||= 20
+
+      # Create object from extracted values.
+      LicenseUsageQueryParams.new(start_date: start_date,
+                                  end_date: end_date,
+                                  group_by: group_by,
+                                  cursor: cursor,
+                                  limit: limit)
+    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}, group_by: #{@group_by},"\
+      " cursor: #{@cursor}, limit: #{@limit}>"
+    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},"\
+      " group_by: #{@group_by.inspect}, cursor: #{@cursor.inspect}, limit: #{@limit.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/license_usages.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # LicenseUsages Model.
+  class LicenseUsages < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[LicenseUsage]]
+    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 << (LicenseUsage.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.
+      LicenseUsages.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