orb-billing 0.2.0 → 0.3.1

data/lib/orb/models/credit_note.rb

@@ -91,60 +91,47 @@ module Orb
       #   @return [Time, nil]
       required :voided_at, Time, nil?: true
 
-      # @!attribute [r] discounts
+      # @!attribute discounts
       #   Any discounts applied on the original invoice.
       #
       #   @return [Array<Orb::Models::CreditNote::Discount>, nil]
       optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote::Discount] }
 
-      # @!parse
-      #   # @return [Array<Orb::Models::CreditNote::Discount>]
-      #   attr_writer :discounts
-
-      # @!parse
-      #   # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
-      #   # been applied to a particular invoice.
-      #   #
-      #   # @param id [String]
-      #   # @param created_at [Time]
-      #   # @param credit_note_number [String]
-      #   # @param credit_note_pdf [String, nil]
-      #   # @param customer [Orb::Models::CreditNote::Customer]
-      #   # @param invoice_id [String]
-      #   # @param line_items [Array<Orb::Models::CreditNote::LineItem>]
-      #   # @param maximum_amount_adjustment [Orb::Models::CreditNote::MaximumAmountAdjustment, nil]
-      #   # @param memo [String, nil]
-      #   # @param minimum_amount_refunded [String, nil]
-      #   # @param reason [Symbol, Orb::Models::CreditNote::Reason, nil]
-      #   # @param subtotal [String]
-      #   # @param total [String]
-      #   # @param type [Symbol, Orb::Models::CreditNote::Type]
-      #   # @param voided_at [Time, nil]
-      #   # @param discounts [Array<Orb::Models::CreditNote::Discount>]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     created_at:,
-      #     credit_note_number:,
-      #     credit_note_pdf:,
-      #     customer:,
-      #     invoice_id:,
-      #     line_items:,
-      #     maximum_amount_adjustment:,
-      #     memo:,
-      #     minimum_amount_refunded:,
-      #     reason:,
-      #     subtotal:,
-      #     total:,
-      #     type:,
-      #     voided_at:,
-      #     discounts: nil,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, created_at:, credit_note_number:, credit_note_pdf:, customer:, invoice_id:, line_items:, maximum_amount_adjustment:, memo:, minimum_amount_refunded:, reason:, subtotal:, total:, type:, voided_at:, discounts: nil)
+      #   The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+      #   been applied to a particular invoice.
+      #
+      #   @param id [String] The Orb id of this credit note.
+      #
+      #   @param created_at [Time] The creation time of the resource in Orb.
+      #
+      #   @param credit_note_number [String] The unique identifier for credit notes.
+      #
+      #   @param credit_note_pdf [String, nil] A URL to a PDF of the credit note.
+      #
+      #   @param customer [Orb::Models::CreditNote::Customer]
+      #
+      #   @param invoice_id [String] The id of the invoice resource that this credit note is applied to.
+      #
+      #   @param line_items [Array<Orb::Models::CreditNote::LineItem>] All of the line items associated with this credit note.
+      #
+      #   @param maximum_amount_adjustment [Orb::Models::CreditNote::MaximumAmountAdjustment, nil] The maximum amount applied on the original invoice
+      #
+      #   @param memo [String, nil] An optional memo supplied on the credit note.
+      #
+      #   @param minimum_amount_refunded [String, nil] Any credited amount from the applied minimum on the invoice.
+      #
+      #   @param reason [Symbol, Orb::Models::CreditNote::Reason, nil]
+      #
+      #   @param subtotal [String] The total prior to any creditable invoice-level discounts or minimums.
+      #
+      #   @param total [String] The total including creditable invoice-level discounts or minimums, and tax.
+      #
+      #   @param type [Symbol, Orb::Models::CreditNote::Type]
+      #
+      #   @param voided_at [Time, nil] The time at which the credit note was voided in Orb, if applicable.
+      #
+      #   @param discounts [Array<Orb::Models::CreditNote::Discount>] Any discounts applied on the original invoice.
 
       # @see Orb::Models::CreditNote#customer
       class Customer < Orb::Internal::Type::BaseModel
@@ -158,13 +145,9 @@ module Orb
         #   @return [String, nil]
         required :external_customer_id, String, nil?: true
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param external_customer_id [String, nil]
-        #   #
-        #   def initialize(id:, external_customer_id:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, external_customer_id:)
+        #   @param id [String]
+        #   @param external_customer_id [String, nil]
       end
 
       class LineItem < Orb::Internal::Type::BaseModel
@@ -210,29 +193,28 @@ module Orb
         #   @return [Array<Orb::Models::CreditNote::LineItem::TaxAmount>]
         required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote::LineItem::TaxAmount] }
 
-        # @!attribute [r] discounts
+        # @!attribute discounts
         #   Any line item discounts from the invoice's line item.
         #
         #   @return [Array<Orb::Models::CreditNote::LineItem::Discount>, nil]
         optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote::LineItem::Discount] }
 
-        # @!parse
-        #   # @return [Array<Orb::Models::CreditNote::LineItem::Discount>]
-        #   attr_writer :discounts
-
-        # @!parse
-        #   # @param id [String]
-        #   # @param amount [String]
-        #   # @param item_id [String]
-        #   # @param name [String]
-        #   # @param quantity [Float, nil]
-        #   # @param subtotal [String]
-        #   # @param tax_amounts [Array<Orb::Models::CreditNote::LineItem::TaxAmount>]
-        #   # @param discounts [Array<Orb::Models::CreditNote::LineItem::Discount>]
-        #   #
-        #   def initialize(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil)
+        #   @param id [String] The Orb id of this resource.
+        #
+        #   @param amount [String] The amount of the line item, including any line item minimums and discounts.
+        #
+        #   @param item_id [String] The id of the item associated with this line item.
+        #
+        #   @param name [String] The name of the corresponding invoice line item.
+        #
+        #   @param quantity [Float, nil] An optional quantity credited.
+        #
+        #   @param subtotal [String] The amount of the line item, excluding any line item minimums and discounts.
+        #
+        #   @param tax_amounts [Array<Orb::Models::CreditNote::LineItem::TaxAmount>] Any tax amounts applied onto the line item.
+        #
+        #   @param discounts [Array<Orb::Models::CreditNote::LineItem::Discount>] Any line item discounts from the invoice's line item.
 
         class TaxAmount < Orb::Internal::Type::BaseModel
           # @!attribute amount
@@ -253,14 +235,12 @@ module Orb
           #   @return [String, nil]
           required :tax_rate_percentage, String, nil?: true
 
-          # @!parse
-          #   # @param amount [String]
-          #   # @param tax_rate_description [String]
-          #   # @param tax_rate_percentage [String, nil]
-          #   #
-          #   def initialize(amount:, tax_rate_description:, tax_rate_percentage:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
+          #   @param amount [String] The amount of additional tax incurred by this tax rate.
+          #
+          #   @param tax_rate_description [String] The human-readable description of the applied tax rate.
+          #
+          #   @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
         end
 
         class Discount < Orb::Internal::Type::BaseModel
@@ -299,29 +279,14 @@ module Orb
           #   @return [String, nil]
           optional :reason, String, nil?: true
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param amount_applied [String]
-          #   # @param applies_to_price_ids [Array<String>]
-          #   # @param discount_type [Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType]
-          #   # @param percentage_discount [Float]
-          #   # @param amount_discount [String, nil]
-          #   # @param reason [String, nil]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     amount_applied:,
-          #     applies_to_price_ids:,
-          #     discount_type:,
-          #     percentage_discount:,
-          #     amount_discount: nil,
-          #     reason: nil,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, amount_applied:, applies_to_price_ids:, discount_type:, percentage_discount:, amount_discount: nil, reason: nil)
+          #   @param id [String]
+          #   @param amount_applied [String]
+          #   @param applies_to_price_ids [Array<String>]
+          #   @param discount_type [Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType]
+          #   @param percentage_discount [Float]
+          #   @param amount_discount [String, nil]
+          #   @param reason [String, nil]
 
           # @see Orb::Models::CreditNote::LineItem::Discount#discount_type
           module DiscountType
@@ -330,11 +295,8 @@ module Orb
             PERCENTAGE = :percentage
             AMOUNT = :amount
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end
@@ -368,18 +330,14 @@ module Orb
         #   @return [String, nil]
         optional :reason, String, nil?: true
 
-        # @!parse
-        #   # The maximum amount applied on the original invoice
-        #   #
-        #   # @param amount_applied [String]
-        #   # @param discount_type [Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType]
-        #   # @param percentage_discount [Float]
-        #   # @param applies_to_prices [Array<Orb::Models::CreditNote::MaximumAmountAdjustment::AppliesToPrice>, nil]
-        #   # @param reason [String, nil]
-        #   #
-        #   def initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil)
+        #   The maximum amount applied on the original invoice
+        #
+        #   @param amount_applied [String]
+        #   @param discount_type [Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType]
+        #   @param percentage_discount [Float]
+        #   @param applies_to_prices [Array<Orb::Models::CreditNote::MaximumAmountAdjustment::AppliesToPrice>, nil]
+        #   @param reason [String, nil]
 
         # @see Orb::Models::CreditNote::MaximumAmountAdjustment#discount_type
         module DiscountType
@@ -387,11 +345,8 @@ module Orb
 
           PERCENTAGE = :percentage
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
 
         class AppliesToPrice < Orb::Internal::Type::BaseModel
@@ -405,13 +360,9 @@ module Orb
           #   @return [String]
           required :name, String
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param name [String]
-          #   #
-          #   def initialize(id:, name:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, name:)
+          #   @param id [String]
+          #   @param name [String]
         end
       end
 
@@ -424,11 +375,8 @@ module Orb
         ORDER_CHANGE = :"Order change"
         PRODUCT_UNSATISFACTORY = :"Product unsatisfactory"
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # @see Orb::Models::CreditNote#type
@@ -438,11 +386,8 @@ module Orb
         REFUND = :refund
         ADJUSTMENT = :adjustment
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       class Discount < Orb::Internal::Type::BaseModel
@@ -473,16 +418,12 @@ module Orb
         #   @return [String, nil]
         optional :reason, String, nil?: true
 
-        # @!parse
-        #   # @param amount_applied [String]
-        #   # @param discount_type [Symbol, Orb::Models::CreditNote::Discount::DiscountType]
-        #   # @param percentage_discount [Float]
-        #   # @param applies_to_prices [Array<Orb::Models::CreditNote::Discount::AppliesToPrice>, nil]
-        #   # @param reason [String, nil]
-        #   #
-        #   def initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil)
+        #   @param amount_applied [String]
+        #   @param discount_type [Symbol, Orb::Models::CreditNote::Discount::DiscountType]
+        #   @param percentage_discount [Float]
+        #   @param applies_to_prices [Array<Orb::Models::CreditNote::Discount::AppliesToPrice>, nil]
+        #   @param reason [String, nil]
 
         # @see Orb::Models::CreditNote::Discount#discount_type
         module DiscountType
@@ -490,11 +431,8 @@ module Orb
 
           PERCENTAGE = :percentage
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
 
         class AppliesToPrice < Orb::Internal::Type::BaseModel
@@ -508,13 +446,9 @@ module Orb
           #   @return [String]
           required :name, String
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param name [String]
-          #   #
-          #   def initialize(id:, name:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, name:)
+          #   @param id [String]
+          #   @param name [String]
         end
       end
     end

data/lib/orb/models/credit_note_create_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::CreditNotes#create
     class CreditNoteCreateParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute line_items
@@ -25,15 +24,14 @@ module Orb
       #   @return [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil]
       optional :reason, enum: -> { Orb::Models::CreditNoteCreateParams::Reason }, nil?: true
 
-      # @!parse
-      #   # @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
-      #   # @param memo [String, nil]
-      #   # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(line_items:, memo: nil, reason: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(line_items:, memo: nil, reason: nil, request_options: {})
+      #   @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
+      #
+      #   @param memo [String, nil] An optional memo to attach to the credit note.
+      #
+      #   @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       class LineItem < Orb::Internal::Type::BaseModel
         # @!attribute amount
@@ -48,13 +46,10 @@ module Orb
         #   @return [String]
         required :invoice_line_item_id, String
 
-        # @!parse
-        #   # @param amount [String]
-        #   # @param invoice_line_item_id [String]
-        #   #
-        #   def initialize(amount:, invoice_line_item_id:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(amount:, invoice_line_item_id:)
+        #   @param amount [String] The total amount in the invoice's currency to credit this line item.
+        #
+        #   @param invoice_line_item_id [String] The ID of the line item to credit.
       end
 
       # An optional reason for the credit note.
@@ -66,11 +61,8 @@ module Orb
         ORDER_CHANGE = :order_change
         PRODUCT_UNSATISFACTORY = :product_unsatisfactory
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/orb/models/credit_note_fetch_params.rb

@@ -4,16 +4,11 @@ module Orb
   module Models
     # @see Orb::Resources::CreditNotes#fetch
     class CreditNoteFetchParams < 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/credit_note_list_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::CreditNotes#list
     class CreditNoteListParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute created_at_gt
@@ -35,39 +34,30 @@ module Orb
       #   @return [String, nil]
       optional :cursor, String, nil?: true
 
-      # @!attribute [r] limit
+      # @!attribute limit
       #   The number of items to fetch. Defaults to 20.
       #
       #   @return [Integer, nil]
       optional :limit, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :limit
-
-      # @!parse
-      #   # @param created_at_gt [Time, nil]
-      #   # @param created_at_gte [Time, nil]
-      #   # @param created_at_lt [Time, nil]
-      #   # @param created_at_lte [Time, nil]
-      #   # @param cursor [String, nil]
-      #   # @param limit [Integer]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     created_at_gt: nil,
-      #     created_at_gte: nil,
-      #     created_at_lt: nil,
-      #     created_at_lte: nil,
-      #     cursor: nil,
-      #     limit: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CreditNoteListParams} for more details.
+      #
+      #   @param created_at_gt [Time, nil]
+      #
+      #   @param created_at_gte [Time, nil]
+      #
+      #   @param created_at_lt [Time, nil]
+      #
+      #   @param created_at_lte [Time, nil]
+      #
+      #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #   ...
+      #
+      #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end