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

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

@@ -6,12 +6,15 @@ module Stigg
       # @see Stigg::Resources::V1::Subscriptions#transfer
       class SubscriptionTransferResponse < Stigg::Internal::Type::BaseModel
         # @!attribute data
+        #   Customer subscription to a plan
         #
         #   @return [Stigg::Models::V1::SubscriptionTransferResponse::Data]
         required :data, -> { Stigg::Models::V1::SubscriptionTransferResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [Stigg::Models::V1::SubscriptionTransferResponse::Data]
+        #   Response object
+        #
+        #   @param data [Stigg::Models::V1::SubscriptionTransferResponse::Data] Customer subscription to a plan
 
         # @see Stigg::Models::V1::SubscriptionTransferResponse#data
         class Data < Stigg::Internal::Type::BaseModel
@@ -133,6 +136,12 @@ module Stigg
                    api_name: :paymentCollectionMethod,
                    nil?: true
 
+          # @!attribute prices
+          #
+          #   @return [Array<Stigg::Models::V1::SubscriptionTransferResponse::Data::Price>, nil]
+          optional :prices,
+                   -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::SubscriptionTransferResponse::Data::Price] }
+
           # @!attribute resource_id
           #   Resource ID
           #
@@ -145,7 +154,9 @@ module Stigg
           #   @return [Time, nil]
           optional :trial_end_date, Time, api_name: :trialEndDate, nil?: true
 
-          # @!method initialize(id:, billing_id:, created_at:, customer_id:, payment_collection:, plan_id:, pricing_type:, start_date:, status:, cancellation_date: nil, cancel_reason: nil, current_billing_period_end: nil, current_billing_period_start: nil, effective_end_date: nil, end_date: nil, metadata: nil, paying_customer_id: nil, payment_collection_method: nil, resource_id: nil, trial_end_date: nil)
+          # @!method initialize(id:, billing_id:, created_at:, customer_id:, payment_collection:, plan_id:, pricing_type:, start_date:, status:, cancellation_date: nil, cancel_reason: nil, current_billing_period_end: nil, current_billing_period_start: nil, effective_end_date: nil, end_date: nil, metadata: nil, paying_customer_id: nil, payment_collection_method: nil, prices: nil, resource_id: nil, trial_end_date: nil)
+          #   Customer subscription to a plan
+          #
           #   @param id [String] Subscription ID
           #
           #   @param billing_id [String, nil] Billing ID
@@ -182,6 +193,8 @@ module Stigg
           #
           #   @param payment_collection_method [Symbol, Stigg::Models::V1::SubscriptionTransferResponse::Data::PaymentCollectionMethod, nil] The method used to collect payments for a subscription
           #
+          #   @param prices [Array<Stigg::Models::V1::SubscriptionTransferResponse::Data::Price>]
+          #
           #   @param resource_id [String, nil] Resource ID
           #
           #   @param trial_end_date [Time, nil] Subscription trial end date
@@ -267,6 +280,33 @@ module Stigg
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          class Price < Stigg::Internal::Type::BaseModel
+            # @!attribute id
+            #   Price ID
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute created_at
+            #   Creation timestamp
+            #
+            #   @return [String]
+            required :created_at, String, api_name: :createdAt
+
+            # @!attribute updated_at
+            #   Last update timestamp
+            #
+            #   @return [String]
+            required :updated_at, String, api_name: :updatedAt
+
+            # @!method initialize(id:, created_at:, updated_at:)
+            #   @param id [String] Price ID
+            #
+            #   @param created_at [String] Creation timestamp
+            #
+            #   @param updated_at [String] Last update timestamp
+          end
         end
       end
     end

data/lib/stigg/models/v1/subscriptions/future_update_cancel_pending_payment_response.rb

@@ -12,6 +12,8 @@ module Stigg
           required :data, -> { Stigg::Models::V1::Subscriptions::FutureUpdateCancelPendingPaymentResponse::Data }
 
           # @!method initialize(data:)
+          #   Response object
+          #
           #   @param data [Stigg::Models::V1::Subscriptions::FutureUpdateCancelPendingPaymentResponse::Data]
 
           # @see Stigg::Models::V1::Subscriptions::FutureUpdateCancelPendingPaymentResponse#data

data/lib/stigg/models/v1/subscriptions/future_update_cancel_schedule_response.rb

@@ -12,6 +12,8 @@ module Stigg
           required :data, -> { Stigg::Models::V1::Subscriptions::FutureUpdateCancelScheduleResponse::Data }
 
           # @!method initialize(data:)
+          #   Response object
+          #
           #   @param data [Stigg::Models::V1::Subscriptions::FutureUpdateCancelScheduleResponse::Data]
 
           # @see Stigg::Models::V1::Subscriptions::FutureUpdateCancelScheduleResponse#data

data/lib/stigg/models/v1_create_event_params.rb

@@ -57,6 +57,8 @@ module Stigg
         optional :timestamp, Time
 
         # @!method initialize(customer_id:, event_name:, idempotency_key:, dimensions: nil, resource_id: nil, timestamp: nil)
+        #   Raw usage event
+        #
         #   @param customer_id [String] Customer id
         #
         #   @param event_name [String] The name of the usage event

data/lib/stigg/models/v1_create_event_response.rb

@@ -5,12 +5,19 @@ module Stigg
     # @see Stigg::Resources::V1#create_event
     class V1CreateEventResponse < Stigg::Internal::Type::BaseModel
       # @!attribute data
+      #   Empty success response confirming that events were successfully ingested and
+      #   queued for processing by Stigg's metering system.
       #
       #   @return [Object]
       required :data, Stigg::Internal::Type::Unknown
 
       # @!method initialize(data:)
-      #   @param data [Object]
+      #   Some parameter documentations has been truncated, see
+      #   {Stigg::Models::V1CreateEventResponse} for more details.
+      #
+      #   Response object
+      #
+      #   @param data [Object] Empty success response confirming that events were successfully ingested and que
     end
   end
 end

data/lib/stigg/models/v1_create_usage_params.rb

@@ -46,8 +46,9 @@ module Stigg
         # @!attribute dimensions
         #   Additional dimensions for the usage report
         #
-        #   @return [Hash{Symbol=>String}, nil]
-        optional :dimensions, Stigg::Internal::Type::HashOf[String]
+        #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
+        optional :dimensions,
+                 -> { Stigg::Internal::Type::HashOf[union: Stigg::V1CreateUsageParams::Usage::Dimension] }
 
         # @!attribute resource_id
         #   Resource id
@@ -64,6 +65,8 @@ module Stigg
                  api_name: :updateBehavior
 
         # @!method initialize(customer_id:, feature_id:, value:, created_at: nil, dimensions: nil, resource_id: nil, update_behavior: nil)
+        #   Single usage measurement
+        #
         #   @param customer_id [String] Customer id
         #
         #   @param feature_id [String] Feature id
@@ -72,12 +75,25 @@ module Stigg
         #
         #   @param created_at [Time] Timestamp of when the record was created
         #
-        #   @param dimensions [Hash{Symbol=>String}] Additional dimensions for the usage report
+        #   @param dimensions [Hash{Symbol=>String, Float, Boolean}] Additional dimensions for the usage report
         #
         #   @param resource_id [String, nil] Resource id
         #
         #   @param update_behavior [Symbol, Stigg::Models::V1CreateUsageParams::Usage::UpdateBehavior] The method by which the usage value should be updated
 
+        module Dimension
+          extend Stigg::Internal::Type::Union
+
+          variant String
+
+          variant Float
+
+          variant Stigg::Internal::Type::Boolean
+
+          # @!method self.variants
+          #   @return [Array(String, Float, Boolean)]
+        end
+
         # The method by which the usage value should be updated
         #
         # @see Stigg::Models::V1CreateUsageParams::Usage#update_behavior

data/lib/stigg/models/v1_create_usage_response.rb

@@ -5,12 +5,16 @@ module Stigg
     # @see Stigg::Resources::V1#create_usage
     class V1CreateUsageResponse < Stigg::Internal::Type::BaseModel
       # @!attribute data
+      #   Array of usage measurements with current values and period info
       #
       #   @return [Array<Stigg::Models::V1CreateUsageResponse::Data>]
       required :data, -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1CreateUsageResponse::Data] }
 
       # @!method initialize(data:)
-      #   @param data [Array<Stigg::Models::V1CreateUsageResponse::Data>]
+      #   Response containing reported usage measurements with current usage values,
+      #   period information, and reset dates for each measurement.
+      #
+      #   @param data [Array<Stigg::Models::V1CreateUsageResponse::Data>] Array of usage measurements with current values and period info
 
       class Data < Stigg::Internal::Type::BaseModel
         # @!attribute id
@@ -85,6 +89,8 @@ module Stigg
         #   Some parameter documentations has been truncated, see
         #   {Stigg::Models::V1CreateUsageResponse::Data} for more details.
         #
+        #   Recorded usage with period info
+        #
         #   @param id [String] Unique identifier for the entity
         #
         #   @param created_at [Time] Timestamp of when the record was created

data/lib/stigg/resources/v1/coupons.rb

@@ -4,7 +4,7 @@ module Stigg
   module Resources
     class V1
       class Coupons
-        # Create a new Coupon
+        # Create coupon
         #
         # @overload create(id:, amounts_off:, description:, duration_in_months:, name:, percent_off:, additional_meta_data: nil, request_options: {})
         #
@@ -38,11 +38,12 @@ module Stigg
           )
         end
 
-        # Get a single Coupon by id
+        # Get a single coupon by ID
         #
         # @overload retrieve(id, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] The unique identifier of the entity
+        #
         # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Stigg::Models::V1::CouponRetrieveResponse]
@@ -57,19 +58,19 @@ module Stigg
           )
         end
 
-        # Get a list of Coupons
+        # Get a list of coupons
         #
-        # @overload list(ending_before: nil, limit: nil, starting_after: nil, request_options: {})
+        # @overload list(after: nil, before: nil, limit: nil, request_options: {})
         #
-        # @param ending_before [String] Ending before this UUID for pagination
+        # @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}, nil]
         #
-        # @return [Stigg::Models::V1::CouponListResponse]
+        # @return [Stigg::Internal::MyCursorIDPage<Stigg::Models::V1::CouponListResponse>]
         #
         # @see Stigg::Models::V1::CouponListParams
         def list(params = {})
@@ -77,7 +78,8 @@ module Stigg
           @client.request(
             method: :get,
             path: "api/v1/coupons",
-            query: parsed.transform_keys(ending_before: "endingBefore", starting_after: "startingAfter"),
+            query: parsed,
+            page: Stigg::Internal::MyCursorIDPage,
             model: Stigg::Models::V1::CouponListResponse,
             options: options
           )

data/lib/stigg/resources/v1/customers/payment_method.rb

@@ -5,11 +5,11 @@ module Stigg
     class V1
       class Customers
         class PaymentMethod
-          # Perform payment-method attachment on a Customer
+          # Attach payment method
           #
           # @overload attach(id, integration_id:, payment_method_id:, vendor_identifier:, billing_currency: nil, request_options: {})
           #
-          # @param id [String]
+          # @param id [String] The unique identifier of the entity
           #
           # @param integration_id [String] Integration details
           #
@@ -17,7 +17,7 @@ module Stigg
           #
           # @param vendor_identifier [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::VendorIdentifier] The vendor identifier of integration
           #
-          # @param billing_currency [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::BillingCurrency, nil]
+          # @param billing_currency [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::BillingCurrency, nil] Customers selected currency
           #
           # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -35,11 +35,12 @@ module Stigg
             )
           end
 
-          # Perform payment-method detachment on a Customer
+          # Detach payment method
           #
           # @overload detach(id, request_options: {})
           #
-          # @param id [String]
+          # @param id [String] The unique identifier of the entity
+          #
           # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Stigg::Models::V1::CustomerResponse]

data/lib/stigg/resources/v1/customers/usage.rb

@@ -5,47 +5,6 @@ module Stigg
     class V1
       class Customers
         class Usage
-          # Perform retrieval on a Usage history
-          #
-          # @overload retrieve(feature_id, customer_id:, start_date:, end_date: nil, group_by: nil, resource_id: nil, request_options: {})
-          #
-          # @param feature_id [String] Path param: Feature id
-          #
-          # @param customer_id [String] Path param: Customer id
-          #
-          # @param start_date [Time] Query param: The start date of the range
-          #
-          # @param end_date [Time] Query param: The end date of the range
-          #
-          # @param group_by [String] Query param
-          #
-          # @param resource_id [String, nil] Query param: Resource id
-          #
-          # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [Stigg::Models::V1::Customers::UsageRetrieveResponse]
-          #
-          # @see Stigg::Models::V1::Customers::UsageRetrieveParams
-          def retrieve(feature_id, params)
-            parsed, options = Stigg::V1::Customers::UsageRetrieveParams.dump_request(params)
-            customer_id =
-              parsed.delete(:customer_id) do
-                raise ArgumentError.new("missing required path argument #{_1}")
-              end
-            @client.request(
-              method: :get,
-              path: ["api/v1/customers/%1$s/usage/features/%2$s", customer_id, feature_id],
-              query: parsed.transform_keys(
-                start_date: "startDate",
-                end_date: "endDate",
-                group_by: "groupBy",
-                resource_id: "resourceId"
-              ),
-              model: Stigg::Models::V1::Customers::UsageRetrieveResponse,
-              options: options
-            )
-          end
-
           # @api private
           #
           # @param client [Stigg::Client]

data/lib/stigg/resources/v1/customers.rb

@@ -10,10 +10,7 @@ module Stigg
         # @return [Stigg::Resources::V1::Customers::Usage]
         attr_reader :usage
 
-        # @return [Stigg::Resources::V1::Customers::Promotional]
-        attr_reader :promotional
-
-        # Create a new Customer
+        # Provision customer
         #
         # @overload create(id:, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, metadata: nil, name: nil, request_options: {})
         #
@@ -47,11 +44,12 @@ module Stigg
           )
         end
 
-        # Get a single Customer by id
+        # Get a single customer by ID
         #
         # @overload retrieve(id, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] The unique identifier of the entity
+        #
         # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Stigg::Models::V1::CustomerResponse]
@@ -66,11 +64,11 @@ module Stigg
           )
         end
 
-        # Update an existing Customer
+        # Update a customer
         #
         # @overload update(id, coupon_id: nil, email: nil, integrations: nil, metadata: nil, name: nil, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] The unique identifier of the entity
         #
         # @param coupon_id [String, nil] Customer level coupon
         #
@@ -98,19 +96,19 @@ module Stigg
           )
         end
 
-        # Get a list of Customers
+        # Get a list of customers
         #
-        # @overload list(ending_before: nil, limit: nil, starting_after: nil, request_options: {})
+        # @overload list(after: nil, before: nil, limit: nil, request_options: {})
         #
-        # @param ending_before [String] Ending before this UUID for pagination
+        # @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}, nil]
         #
-        # @return [Stigg::Models::V1::CustomerListResponse]
+        # @return [Stigg::Internal::MyCursorIDPage<Stigg::Models::V1::CustomerListResponse>]
         #
         # @see Stigg::Models::V1::CustomerListParams
         def list(params = {})
@@ -118,17 +116,19 @@ module Stigg
           @client.request(
             method: :get,
             path: "api/v1/customers",
-            query: parsed.transform_keys(ending_before: "endingBefore", starting_after: "startingAfter"),
+            query: parsed,
+            page: Stigg::Internal::MyCursorIDPage,
             model: Stigg::Models::V1::CustomerListResponse,
             options: options
           )
         end
 
-        # Perform archive on a Customer
+        # Archive customer
         #
         # @overload archive(id, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] The unique identifier of the entity
+        #
         # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Stigg::Models::V1::CustomerResponse]
@@ -143,11 +143,12 @@ module Stigg
           )
         end
 
-        # Perform unarchive on a Customer
+        # Unarchive customer
         #
         # @overload unarchive(id, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] The unique identifier of the entity
+        #
         # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Stigg::Models::V1::CustomerResponse]
@@ -169,7 +170,6 @@ module Stigg
           @client = client
           @payment_method = Stigg::Resources::V1::Customers::PaymentMethod.new(client: client)
           @usage = Stigg::Resources::V1::Customers::Usage.new(client: client)
-          @promotional = Stigg::Resources::V1::Customers::Promotional.new(client: client)
         end
       end
     end

data/lib/stigg/resources/v1/subscriptions/future_update.rb

@@ -5,11 +5,12 @@ module Stigg
     class V1
       class Subscriptions
         class FutureUpdate
-          # Perform cancel future update on a Subscription
+          # Cancel pending payment update
           #
           # @overload cancel_pending_payment(id, request_options: {})
           #
-          # @param id [String]
+          # @param id [String] The unique identifier of the entity
+          #
           # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Stigg::Models::V1::Subscriptions::FutureUpdateCancelPendingPaymentResponse]
@@ -24,11 +25,12 @@ module Stigg
             )
           end
 
-          # Perform cancel future update on a Subscription
+          # Cancel scheduled update
           #
           # @overload cancel_schedule(id, request_options: {})
           #
-          # @param id [String]
+          # @param id [String] The unique identifier of the entity
+          #
           # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Stigg::Models::V1::Subscriptions::FutureUpdateCancelScheduleResponse]