orb-billing 0.1.3 → 0.3.0

data/lib/orb/models/invoice_create_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Invoices#create
     class InvoiceCreateParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute currency
@@ -70,7 +69,7 @@ module Orb
       #   @return [Hash{Symbol=>String, nil}, nil]
       optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-      # @!attribute [r] will_auto_issue
+      # @!attribute will_auto_issue
       #   When true, this invoice will be submitted for issuance upon creation. When
       #   false, the resulting invoice will require manual review to issue. Defaulted to
       #   false.
@@ -78,41 +77,38 @@ module Orb
       #   @return [Boolean, nil]
       optional :will_auto_issue, Orb::Internal::Type::Boolean
 
-      # @!parse
-      #   # @return [Boolean]
-      #   attr_writer :will_auto_issue
-
-      # @!parse
-      #   # @param currency [String]
-      #   # @param invoice_date [Time]
-      #   # @param line_items [Array<Orb::Models::InvoiceCreateParams::LineItem>]
-      #   # @param net_terms [Integer]
-      #   # @param customer_id [String, nil]
-      #   # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
-      #   # @param external_customer_id [String, nil]
-      #   # @param memo [String, nil]
-      #   # @param metadata [Hash{Symbol=>String, nil}, nil]
-      #   # @param will_auto_issue [Boolean]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     currency:,
-      #     invoice_date:,
-      #     line_items:,
-      #     net_terms:,
-      #     customer_id: nil,
-      #     discount: nil,
-      #     external_customer_id: nil,
-      #     memo: nil,
-      #     metadata: nil,
-      #     will_auto_issue: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(currency:, invoice_date:, line_items:, net_terms:, customer_id: nil, discount: nil, external_customer_id: nil, memo: nil, metadata: nil, will_auto_issue: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceCreateParams} for more details.
+      #
+      #   @param currency [String] An ISO 4217 currency string. Must be the same as the customer's currency if it i
+      #   ...
+      #
+      #   @param invoice_date [Time] Optional invoice date to set. Must be in the past, if not set, `invoice_date` is
+      #   ...
+      #
+      #   @param line_items [Array<Orb::Models::InvoiceCreateParams::LineItem>]
+      #
+      #   @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
+      #   ...
+      #
+      #   @param customer_id [String, nil] The id of the `Customer` to create this invoice for. One of `customer_id` and `e
+      #   ...
+      #
+      #   @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] An optional discount to attach to the invoice.
+      #
+      #   @param external_customer_id [String, nil] The `external_customer_id` of the `Customer` to create this invoice for. One of
+      #   ...
+      #
+      #   @param memo [String, nil] An optional memo to attach to the invoice.
+      #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #   ...
+      #
+      #   @param will_auto_issue [Boolean] When true, this invoice will be submitted for issuance upon creation. When false
+      #   ...
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       class LineItem < Orb::Internal::Type::BaseModel
         # @!attribute end_date
@@ -154,18 +150,20 @@ module Orb
         #   @return [Orb::Models::InvoiceCreateParams::LineItem::UnitConfig]
         required :unit_config, -> { Orb::Models::InvoiceCreateParams::LineItem::UnitConfig }
 
-        # @!parse
-        #   # @param end_date [Date]
-        #   # @param item_id [String]
-        #   # @param model_type [Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType]
-        #   # @param name [String]
-        #   # @param quantity [Float]
-        #   # @param start_date [Date]
-        #   # @param unit_config [Orb::Models::InvoiceCreateParams::LineItem::UnitConfig]
-        #   #
-        #   def initialize(end_date:, item_id:, model_type:, name:, quantity:, start_date:, unit_config:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(end_date:, item_id:, model_type:, name:, quantity:, start_date:, unit_config:)
+        #   @param end_date [Date] A date string to specify the line item's end date in the customer's timezone.
+        #
+        #   @param item_id [String]
+        #
+        #   @param model_type [Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType]
+        #
+        #   @param name [String] The name of the line item.
+        #
+        #   @param quantity [Float] The number of units on the line item
+        #
+        #   @param start_date [Date] A date string to specify the line item's start date in the customer's timezone.
+        #
+        #   @param unit_config [Orb::Models::InvoiceCreateParams::LineItem::UnitConfig]
 
         # @see Orb::Models::InvoiceCreateParams::LineItem#model_type
         module ModelType
@@ -173,11 +171,8 @@ module Orb
 
           UNIT = :unit
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
 
         # @see Orb::Models::InvoiceCreateParams::LineItem#unit_config
@@ -188,12 +183,8 @@ module Orb
           #   @return [String]
           required :unit_amount, String
 
-          # @!parse
-          #   # @param unit_amount [String]
-          #   #
-          #   def initialize(unit_amount:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(unit_amount:)
+          #   @param unit_amount [String] Rate per unit of usage
         end
       end
     end

data/lib/orb/models/invoice_fetch_params.rb

@@ -4,16 +4,11 @@ module Orb
   module Models
     # @see Orb::Resources::Invoices#fetch
     class InvoiceFetchParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!parse
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/orb/models/invoice_fetch_upcoming_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Invoices#fetch_upcoming
     class InvoiceFetchUpcomingParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute subscription_id
@@ -13,13 +12,9 @@ module Orb
       #   @return [String]
       required :subscription_id, String
 
-      # @!parse
-      #   # @param subscription_id [String]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(subscription_id:, request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(subscription_id:, request_options: {})
+      #   @param subscription_id [String]
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end