stigg 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dad9def9c2060ac8c54995c4f63a0497d1c14a2022d7b6569925aca298bbcdaa
-  data.tar.gz: f50551f0e1863014f5b3dfaa2dde3e789c035bdef3898626ff21b51ef32d6535
+  metadata.gz: '09fe96600df45ed243157d6113eba1fc3d9f67bd83ef3f1dcb14c26aa300c416'
+  data.tar.gz: 930196b64fdd388d266e858a894c274118514670520f6a384a898d2c1ebf9e13
 SHA512:
-  metadata.gz: 751c86239a5713845dd854d30c4ac147750aa4aefe5403be71dc123813a108234d941a4c2c637fb4e5e78f8e22f0cef9a29acf8f89b8e5b6c43466931738ddc7
-  data.tar.gz: 440230700abfdf4768089e975647a0425284bab3407e39b1aa749a98fa9c30a86f1c9c621dd85f49e2d64c51b89801ebb602f1474b03f522f32c815b1b0ad9eb
+  metadata.gz: 70a186ffd28a9dc88c13394fc9436c1b4b2e72b6679255467c40251cccfc36a4cea98ee2a903bf4444070085fc637c07f8e66cc98f49881f9f6be08911d725bd
+  data.tar.gz: 712f901dbcfc87504a817aa47ec18f51ff62693e25031bfd0ba3509b90b2c19747783da7b15307a0f62d58093a9f90451abeb102b15f0aa55635f6ef4f2d5301

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.1.0-alpha.2 (2026-01-28)
+
+Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)
+
+### Features
+
+* **api:** api update ([5401740](https://github.com/stiggio/stigg-ruby/commit/5401740b164e4f2e4dfec6b1551d4c6bba400eda))
+* **api:** api update ([af0dbbf](https://github.com/stiggio/stigg-ruby/commit/af0dbbfbe7cabffe473c52077d91594b7c4ec181))
+* **api:** api update ([985e956](https://github.com/stiggio/stigg-ruby/commit/985e9563afe956a76da955a97571a93ba293b097))
+* **api:** api update ([fa4a31b](https://github.com/stiggio/stigg-ruby/commit/fa4a31b7afa59ab427d38557fab38d93ad72ca28))
+* **api:** api update ([59c9248](https://github.com/stiggio/stigg-ruby/commit/59c92487bd880f091b5c4411c2c8c15491bc7ec2))
+* **api:** comment out promotional endpoints ([3c40e53](https://github.com/stiggio/stigg-ruby/commit/3c40e538184cca72a2048129672b65eb787f466c))
+* **api:** improved cursor pagination ([b5650f4](https://github.com/stiggio/stigg-ruby/commit/b5650f4dcd6d97b8539ea76426aece84f8741496))
+
 ## 0.1.0-alpha.1 (2026-01-26)
 
 Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/stiggio/stigg-ruby/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "stigg", "~> 0.1.0.pre.alpha.1"
+gem "stigg", "~> 0.1.0.pre.alpha.2"
 ```
 
 <!-- x-release-please-end -->
@@ -35,6 +35,34 @@ customer_response = stigg.v1.customers.retrieve("REPLACE_ME")
 puts(customer_response.data)
 ```
 
+### Pagination
+
+List methods in the Stigg API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```ruby
+page = stigg.v1.customers.list(limit: 30)
+
+# Fetch single item from page.
+customer = page.data[0]
+puts(customer.id)
+
+# Automatically fetches more pages as needed.
+page.auto_paging_each do |customer|
+  puts(customer.id)
+end
+```
+
+Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
+
+```ruby
+if page.next_page?
+  new_page = page.next_page
+  puts(new_page.data[0].id)
+end
+```
+
 ### Handling errors
 
 When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Stigg::Errors::APIError` will be thrown:

data/lib/stigg/internal/my_cursor_id_page.rb

@@ -10,8 +10,8 @@ module Stigg
     #   end
     #
     # @example
-    #   my_cursor_id_page.auto_paging_each do |item|
-    #     puts(item)
+    #   my_cursor_id_page.auto_paging_each do |customer|
+    #     puts(customer)
     #   end
     class MyCursorIDPage
       include Stigg::Internal::Type::BasePage
@@ -19,9 +19,12 @@ module Stigg
       # @return [Array<generic<Elem>>, nil]
       attr_accessor :data
 
+      # @return [Pagination]
+      attr_accessor :pagination
+
       # @return [Boolean]
       def next_page?
-        !data.to_a.empty?
+        !data.to_a.empty? && (!pagination&.prev.to_s.empty? || !pagination&.next_.to_s.empty?)
       end
 
       # @raise [Stigg::HTTP::Error]
@@ -32,7 +35,10 @@ module Stigg
           raise RuntimeError.new(message)
         end
 
-        req = Stigg::Internal::Util.deep_merge(@req, {query: {starting_after: data&.last&.cursor_id}})
+        req = Stigg::Internal::Util.deep_merge(
+          @req,
+          {query: pagination&.prev.nil? ? {after: pagination&.next_} : {before: pagination&.prev}}
+        )
         @client.request(req)
       end
 
@@ -67,6 +73,12 @@ module Stigg
           @data = data.map { Stigg::Internal::Type::Converter.coerce(@model, _1) }
         else
         end
+        case page_data
+        in {pagination: Hash | nil => pagination}
+          @pagination =
+            Stigg::Internal::Type::Converter.coerce(Stigg::Internal::MyCursorIDPage::Pagination, pagination)
+        else
+        end
       end
 
       # @api private
@@ -77,6 +89,22 @@ module Stigg
 
         "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
       end
+
+      class Pagination < Stigg::Internal::Type::BaseModel
+        # @!attribute next_
+        #
+        #   @return [String, nil]
+        optional :next_, String, api_name: :next
+
+        # @!attribute prev
+        #
+        #   @return [String, nil]
+        optional :prev, String
+
+        # @!method initialize(next_: nil, prev: nil)
+        #   @param next_ [String]
+        #   @param prev [String]
+      end
     end
   end
 end

data/lib/stigg/models/v1/coupon_create_params.rb

@@ -84,6 +84,8 @@ module Stigg
           required :currency, enum: -> { Stigg::V1::CouponCreateParams::AmountsOff::Currency }
 
           # @!method initialize(amount:, currency:)
+          #   Monetary amount with currency
+          #
           #   @param amount [Float] The price amount
           #
           #   @param currency [Symbol, Stigg::Models::V1::CouponCreateParams::AmountsOff::Currency] The price currency

data/lib/stigg/models/v1/coupon_create_response.rb

@@ -6,12 +6,15 @@ module Stigg
       # @see Stigg::Resources::V1::Coupons#create
       class CouponCreateResponse < Stigg::Internal::Type::BaseModel
         # @!attribute data
+        #   Discount instrument with percentage or fixed amount
         #
         #   @return [Stigg::Models::V1::CouponCreateResponse::Data]
         required :data, -> { Stigg::Models::V1::CouponCreateResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [Stigg::Models::V1::CouponCreateResponse::Data]
+        #   Response object
+        #
+        #   @param data [Stigg::Models::V1::CouponCreateResponse::Data] Discount instrument with percentage or fixed amount
 
         # @see Stigg::Models::V1::CouponCreateResponse#data
         class Data < Stigg::Internal::Type::BaseModel
@@ -97,6 +100,8 @@ module Stigg
           required :updated_at, Time, api_name: :updatedAt
 
           # @!method initialize(id:, amounts_off:, billing_id:, billing_link_url:, created_at:, description:, duration_in_months:, name:, percent_off:, source:, status:, type:, updated_at:)
+          #   Discount instrument with percentage or fixed amount
+          #
           #   @param id [String] The unique identifier for the entity
           #
           #   @param amounts_off [Array<Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff>, nil] Fixed amount discounts in different currencies
@@ -133,15 +138,15 @@ module Stigg
             # @!attribute currency
             #   The price currency
             #
-            #   @return [Symbol, Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency, nil]
-            required :currency,
-                     enum: -> { Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency },
-                     nil?: true
+            #   @return [Symbol, Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency]
+            required :currency, enum: -> { Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency }
 
             # @!method initialize(amount:, currency:)
+            #   Monetary amount with currency
+            #
             #   @param amount [Float] The price amount
             #
-            #   @param currency [Symbol, Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency, nil] The price currency
+            #   @param currency [Symbol, Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency] The price currency
 
             # The price currency
             #

data/lib/stigg/models/v1/coupon_list_params.rb

@@ -8,30 +8,30 @@ module Stigg
         extend Stigg::Internal::Type::RequestParameters::Converter
         include Stigg::Internal::Type::RequestParameters
 
-        # @!attribute ending_before
-        #   Ending before this UUID for pagination
+        # @!attribute after
+        #   Return items that come after this cursor
         #
         #   @return [String, nil]
-        optional :ending_before, String
+        optional :after, String
+
+        # @!attribute before
+        #   Return items that come before this cursor
+        #
+        #   @return [String, nil]
+        optional :before, String
 
         # @!attribute limit
-        #   Items per page
+        #   Maximum number of items to return
         #
         #   @return [Integer, nil]
         optional :limit, Integer
 
-        # @!attribute starting_after
-        #   Starting after this UUID for pagination
-        #
-        #   @return [String, nil]
-        optional :starting_after, String
-
-        # @!method initialize(ending_before: nil, limit: nil, starting_after: nil, request_options: {})
-        #   @param ending_before [String] Ending before this UUID for pagination
+        # @!method initialize(after: nil, before: nil, limit: nil, request_options: {})
+        #   @param after [String] Return items that come after this cursor
         #
-        #   @param limit [Integer] Items per page
+        #   @param before [String] Return items that come before this cursor
         #
-        #   @param starting_after [String] Starting after this UUID for pagination
+        #   @param limit [Integer] Maximum number of items to return
         #
         #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
       end