stigg 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.3

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

@@ -7,51 +7,15 @@ module Stigg
         # @return [Stigg::Resources::V1::Customers::PaymentMethod]
         attr_reader :payment_method
 
-        # @return [Stigg::Resources::V1::Customers::Usage]
-        attr_reader :usage
+        # @return [Stigg::Resources::V1::Customers::PromotionalEntitlements]
+        attr_reader :promotional_entitlements
 
-        # @return [Stigg::Resources::V1::Customers::Promotional]
-        attr_reader :promotional
-
-        # Create a new Customer
-        #
-        # @overload create(id:, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, metadata: nil, name: nil, request_options: {})
-        #
-        # @param id [String] Customer slug
-        #
-        # @param coupon_id [String, nil] Customer level coupon
-        #
-        # @param default_payment_method [Stigg::Models::V1::CustomerCreateParams::DefaultPaymentMethod, nil] The default payment method details
-        #
-        # @param email [String, nil] The email of the customer
-        #
-        # @param integrations [Array<Stigg::Models::V1::CustomerCreateParams::Integration>] List of integrations
-        #
-        # @param metadata [Hash{Symbol=>String}] Additional metadata
-        #
-        # @param name [String, nil] The name of the customer
-        #
-        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Stigg::Models::V1::CustomerResponse]
-        #
-        # @see Stigg::Models::V1::CustomerCreateParams
-        def create(params)
-          parsed, options = Stigg::V1::CustomerCreateParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "api/v1/customers",
-            body: parsed,
-            model: Stigg::V1::CustomerResponse,
-            options: options
-          )
-        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 +30,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 +62,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 +82,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 +109,68 @@ module Stigg
           )
         end
 
-        # Perform unarchive on a Customer
+        # Bulk import customers
+        #
+        # @overload import(customers:, request_options: {})
+        #
+        # @param customers [Array<Stigg::Models::V1::CustomerImportParams::Customer>] List of customer objects to import
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::CustomerImportResponse]
+        #
+        # @see Stigg::Models::V1::CustomerImportParams
+        def import(params)
+          parsed, options = Stigg::V1::CustomerImportParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "api/v1/customers/import",
+            body: parsed,
+            model: Stigg::Models::V1::CustomerImportResponse,
+            options: options
+          )
+        end
+
+        # Provision customer
+        #
+        # @overload provision(id:, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, metadata: nil, name: nil, request_options: {})
+        #
+        # @param id [String] Customer slug
+        #
+        # @param coupon_id [String, nil] Customer level coupon
+        #
+        # @param default_payment_method [Stigg::Models::V1::CustomerProvisionParams::DefaultPaymentMethod, nil] The default payment method details
+        #
+        # @param email [String, nil] The email of the customer
+        #
+        # @param integrations [Array<Stigg::Models::V1::CustomerProvisionParams::Integration>] List of integrations
+        #
+        # @param metadata [Hash{Symbol=>String}] Additional metadata
+        #
+        # @param name [String, nil] The name of the customer
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::CustomerResponse]
+        #
+        # @see Stigg::Models::V1::CustomerProvisionParams
+        def provision(params)
+          parsed, options = Stigg::V1::CustomerProvisionParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "api/v1/customers",
+            body: parsed,
+            model: Stigg::V1::CustomerResponse,
+            options: options
+          )
+        end
+
+        # 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]
@@ -168,8 +191,7 @@ module Stigg
         def initialize(client:)
           @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)
+          @promotional_entitlements = Stigg::Resources::V1::Customers::PromotionalEntitlements.new(client: client)
         end
       end
     end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Resources
+    class V1
+      class Events
+        # Report usage events
+        #
+        # @overload report(events:, request_options: {})
+        #
+        # @param events [Array<Stigg::Models::V1::EventReportParams::Event>] A list of usage events to report
+        #
+        # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Stigg::Models::V1::EventReportResponse]
+        #
+        # @see Stigg::Models::V1::EventReportParams
+        def report(params)
+          parsed, options = Stigg::V1::EventReportParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "api/v1/events",
+            body: parsed,
+            model: Stigg::Models::V1::EventReportResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Stigg::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -5,40 +5,42 @@ 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]
+          # @return [Stigg::Models::V1::Subscriptions::CancelSubscription]
           #
           # @see Stigg::Models::V1::Subscriptions::FutureUpdateCancelPendingPaymentParams
           def cancel_pending_payment(id, params = {})
             @client.request(
               method: :delete,
               path: ["api/v1/subscriptions/%1$s/future-update/pending-payment", id],
-              model: Stigg::Models::V1::Subscriptions::FutureUpdateCancelPendingPaymentResponse,
+              model: Stigg::V1::Subscriptions::CancelSubscription,
               options: params[:request_options]
             )
           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]
+          # @return [Stigg::Models::V1::Subscriptions::CancelSubscription]
           #
           # @see Stigg::Models::V1::Subscriptions::FutureUpdateCancelScheduleParams
           def cancel_schedule(id, params = {})
             @client.request(
               method: :delete,
               path: ["api/v1/subscriptions/%1$s/future-update/schedule", id],
-              model: Stigg::Models::V1::Subscriptions::FutureUpdateCancelScheduleResponse,
+              model: Stigg::V1::Subscriptions::CancelSubscription,
               options: params[:request_options]
             )
           end