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

data/lib/stigg/models/v1/customer_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

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

@@ -5,216 +5,202 @@ module Stigg
     module V1
       # @see Stigg::Resources::V1::Customers#list
       class CustomerListResponse < Stigg::Internal::Type::BaseModel
-        # @!attribute data
+        # @!attribute id
+        #   Customer slug
         #
-        #   @return [Array<Stigg::Models::V1::CustomerListResponse::Data>]
-        required :data, -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::CustomerListResponse::Data] }
+        #   @return [String]
+        required :id, String
 
-        # @!method initialize(data:)
-        #   @param data [Array<Stigg::Models::V1::CustomerListResponse::Data>]
+        # @!attribute archived_at
+        #   Timestamp of when the record was deleted
+        #
+        #   @return [Time, nil]
+        required :archived_at, Time, api_name: :archivedAt, nil?: true
 
-        class Data < Stigg::Internal::Type::BaseModel
-          # @!attribute id
-          #   Customer slug
-          #
-          #   @return [String]
-          required :id, String
+        # @!attribute created_at
+        #   Timestamp of when the record was created
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
 
-          # @!attribute archived_at
-          #   Timestamp of when the record was deleted
-          #
-          #   @return [Time, nil]
-          required :archived_at, Time, api_name: :archivedAt, nil?: true
+        # @!attribute updated_at
+        #   Timestamp of when the record was last updated
+        #
+        #   @return [Time]
+        required :updated_at, Time, api_name: :updatedAt
 
-          # @!attribute created_at
-          #   Timestamp of when the record was created
-          #
-          #   @return [Time]
-          required :created_at, Time, api_name: :createdAt
+        # @!attribute coupon_id
+        #   Customer level coupon
+        #
+        #   @return [String, nil]
+        optional :coupon_id, String, api_name: :couponId, nil?: true
 
-          # @!attribute cursor_id
-          #   Cursor ID for query pagination
-          #
-          #   @return [String]
-          required :cursor_id, String, api_name: :cursorId
+        # @!attribute default_payment_method
+        #   The default payment method details
+        #
+        #   @return [Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod, nil]
+        optional :default_payment_method,
+                 -> { Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod },
+                 api_name: :defaultPaymentMethod,
+                 nil?: true
+
+        # @!attribute email
+        #   The email of the customer
+        #
+        #   @return [String, nil]
+        optional :email, String, nil?: true
 
-          # @!attribute updated_at
-          #   Timestamp of when the record was last updated
-          #
-          #   @return [Time]
-          required :updated_at, Time, api_name: :updatedAt
+        # @!attribute integrations
+        #   List of integrations
+        #
+        #   @return [Array<Stigg::Models::V1::CustomerListResponse::Integration>, nil]
+        optional :integrations,
+                 -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::CustomerListResponse::Integration] }
 
-          # @!attribute coupon_id
-          #   Customer level coupon
-          #
-          #   @return [String, nil]
-          optional :coupon_id, String, api_name: :couponId, nil?: true
+        # @!attribute metadata
+        #   Additional metadata
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, Stigg::Internal::Type::HashOf[String]
 
-          # @!attribute default_payment_method
-          #   The default payment method details
-          #
-          #   @return [Stigg::Models::V1::CustomerListResponse::Data::DefaultPaymentMethod, nil]
-          optional :default_payment_method,
-                   -> { Stigg::Models::V1::CustomerListResponse::Data::DefaultPaymentMethod },
-                   api_name: :defaultPaymentMethod,
-                   nil?: true
+        # @!attribute name
+        #   The name of the customer
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(id:, archived_at:, created_at:, updated_at:, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, metadata: nil, name: nil)
+        #   A customer can be either an organization or an individual
+        #
+        #   @param id [String] Customer slug
+        #
+        #   @param archived_at [Time, nil] Timestamp of when the record was deleted
+        #
+        #   @param created_at [Time] Timestamp of when the record was created
+        #
+        #   @param updated_at [Time] Timestamp of when the record was last updated
+        #
+        #   @param coupon_id [String, nil] Customer level coupon
+        #
+        #   @param default_payment_method [Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod, nil] The default payment method details
+        #
+        #   @param email [String, nil] The email of the customer
+        #
+        #   @param integrations [Array<Stigg::Models::V1::CustomerListResponse::Integration>] List of integrations
+        #
+        #   @param metadata [Hash{Symbol=>String}] Additional metadata
+        #
+        #   @param name [String, nil] The name of the customer
 
-          # @!attribute email
-          #   The email of the customer
+        # @see Stigg::Models::V1::CustomerListResponse#default_payment_method
+        class DefaultPaymentMethod < Stigg::Internal::Type::BaseModel
+          # @!attribute billing_id
+          #   The default payment method id
           #
           #   @return [String, nil]
-          optional :email, String, nil?: true
+          required :billing_id, String, api_name: :billingId, nil?: true
 
-          # @!attribute integrations
-          #   List of integrations
+          # @!attribute card_expiry_month
+          #   The expiration month of the default payment method
           #
-          #   @return [Array<Stigg::Models::V1::CustomerListResponse::Data::Integration>, nil]
-          optional :integrations,
-                   -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::CustomerListResponse::Data::Integration] }
+          #   @return [Float, nil]
+          required :card_expiry_month, Float, api_name: :cardExpiryMonth, nil?: true
 
-          # @!attribute metadata
-          #   Additional metadata
+          # @!attribute card_expiry_year
+          #   The expiration year of the default payment method
           #
-          #   @return [Hash{Symbol=>String}, nil]
-          optional :metadata, Stigg::Internal::Type::HashOf[String]
+          #   @return [Float, nil]
+          required :card_expiry_year, Float, api_name: :cardExpiryYear, nil?: true
 
-          # @!attribute name
-          #   The name of the customer
+          # @!attribute card_last4_digits
+          #   The last 4 digits of the default payment method
           #
           #   @return [String, nil]
-          optional :name, String, nil?: true
+          required :card_last4_digits, String, api_name: :cardLast4Digits, nil?: true
 
-          # @!method initialize(id:, archived_at:, created_at:, cursor_id:, updated_at:, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, metadata: nil, name: nil)
-          #   @param id [String] Customer slug
-          #
-          #   @param archived_at [Time, nil] Timestamp of when the record was deleted
+          # @!attribute type
+          #   The default payment method type
           #
-          #   @param created_at [Time] Timestamp of when the record was created
-          #
-          #   @param cursor_id [String] Cursor ID for query pagination
-          #
-          #   @param updated_at [Time] Timestamp of when the record was last updated
-          #
-          #   @param coupon_id [String, nil] Customer level coupon
+          #   @return [Symbol, Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod::Type]
+          required :type, enum: -> { Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod::Type }
+
+          # @!method initialize(billing_id:, card_expiry_month:, card_expiry_year:, card_last4_digits:, type:)
+          #   The default payment method details
           #
-          #   @param default_payment_method [Stigg::Models::V1::CustomerListResponse::Data::DefaultPaymentMethod, nil] The default payment method details
+          #   @param billing_id [String, nil] The default payment method id
           #
-          #   @param email [String, nil] The email of the customer
+          #   @param card_expiry_month [Float, nil] The expiration month of the default payment method
           #
-          #   @param integrations [Array<Stigg::Models::V1::CustomerListResponse::Data::Integration>] List of integrations
+          #   @param card_expiry_year [Float, nil] The expiration year of the default payment method
           #
-          #   @param metadata [Hash{Symbol=>String}] Additional metadata
+          #   @param card_last4_digits [String, nil] The last 4 digits of the default payment method
           #
-          #   @param name [String, nil] The name of the customer
+          #   @param type [Symbol, Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod::Type] The default payment method type
 
-          # @see Stigg::Models::V1::CustomerListResponse::Data#default_payment_method
-          class DefaultPaymentMethod < Stigg::Internal::Type::BaseModel
-            # @!attribute billing_id
-            #   The default payment method id
-            #
-            #   @return [String, nil]
-            required :billing_id, String, api_name: :billingId, nil?: true
+          # The default payment method type
+          #
+          # @see Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod#type
+          module Type
+            extend Stigg::Internal::Type::Enum
 
-            # @!attribute card_expiry_month
-            #   The expiration month of the default payment method
-            #
-            #   @return [Float, nil]
-            required :card_expiry_month, Float, api_name: :cardExpiryMonth, nil?: true
+            CARD = :CARD
+            BANK = :BANK
+            CASH_APP = :CASH_APP
 
-            # @!attribute card_expiry_year
-            #   The expiration year of the default payment method
-            #
-            #   @return [Float, nil]
-            required :card_expiry_year, Float, api_name: :cardExpiryYear, nil?: true
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
 
-            # @!attribute card_last4_digits
-            #   The last 4 digits of the default payment method
-            #
-            #   @return [String, nil]
-            required :card_last4_digits, String, api_name: :cardLast4Digits, nil?: true
+        class Integration < Stigg::Internal::Type::BaseModel
+          # @!attribute id
+          #   Integration details
+          #
+          #   @return [String]
+          required :id, String
 
-            # @!attribute type
-            #   The default payment method type
-            #
-            #   @return [Symbol, Stigg::Models::V1::CustomerListResponse::Data::DefaultPaymentMethod::Type]
-            required :type, enum: -> { Stigg::Models::V1::CustomerListResponse::Data::DefaultPaymentMethod::Type }
+          # @!attribute synced_entity_id
+          #   Synced entity id
+          #
+          #   @return [String, nil]
+          required :synced_entity_id, String, api_name: :syncedEntityId, nil?: true
 
-            # @!method initialize(billing_id:, card_expiry_month:, card_expiry_year:, card_last4_digits:, type:)
-            #   The default payment method details
-            #
-            #   @param billing_id [String, nil] The default payment method id
-            #
-            #   @param card_expiry_month [Float, nil] The expiration month of the default payment method
-            #
-            #   @param card_expiry_year [Float, nil] The expiration year of the default payment method
-            #
-            #   @param card_last4_digits [String, nil] The last 4 digits of the default payment method
-            #
-            #   @param type [Symbol, Stigg::Models::V1::CustomerListResponse::Data::DefaultPaymentMethod::Type] The default payment method type
+          # @!attribute vendor_identifier
+          #   The vendor identifier of integration
+          #
+          #   @return [Symbol, Stigg::Models::V1::CustomerListResponse::Integration::VendorIdentifier]
+          required :vendor_identifier,
+                   enum: -> { Stigg::Models::V1::CustomerListResponse::Integration::VendorIdentifier },
+                   api_name: :vendorIdentifier
 
-            # The default payment method type
-            #
-            # @see Stigg::Models::V1::CustomerListResponse::Data::DefaultPaymentMethod#type
-            module Type
-              extend Stigg::Internal::Type::Enum
+          # @!method initialize(id:, synced_entity_id:, vendor_identifier:)
+          #   External billing or CRM integration link
+          #
+          #   @param id [String] Integration details
+          #
+          #   @param synced_entity_id [String, nil] Synced entity id
+          #
+          #   @param vendor_identifier [Symbol, Stigg::Models::V1::CustomerListResponse::Integration::VendorIdentifier] The vendor identifier of integration
 
-              CARD = :CARD
-              BANK = :BANK
-              CASH_APP = :CASH_APP
+          # The vendor identifier of integration
+          #
+          # @see Stigg::Models::V1::CustomerListResponse::Integration#vendor_identifier
+          module VendorIdentifier
+            extend Stigg::Internal::Type::Enum
 
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          end
+            AUTH0 = :AUTH0
+            ZUORA = :ZUORA
+            STRIPE = :STRIPE
+            HUBSPOT = :HUBSPOT
+            AWS_MARKETPLACE = :AWS_MARKETPLACE
+            SNOWFLAKE = :SNOWFLAKE
+            SALESFORCE = :SALESFORCE
+            BIG_QUERY = :BIG_QUERY
+            OPEN_FGA = :OPEN_FGA
+            APP_STORE = :APP_STORE
 
-          class Integration < Stigg::Internal::Type::BaseModel
-            # @!attribute id
-            #   Integration details
-            #
-            #   @return [String]
-            required :id, String
-
-            # @!attribute synced_entity_id
-            #   Synced entity id
-            #
-            #   @return [String, nil]
-            required :synced_entity_id, String, api_name: :syncedEntityId, nil?: true
-
-            # @!attribute vendor_identifier
-            #   The vendor identifier of integration
-            #
-            #   @return [Symbol, Stigg::Models::V1::CustomerListResponse::Data::Integration::VendorIdentifier]
-            required :vendor_identifier,
-                     enum: -> { Stigg::Models::V1::CustomerListResponse::Data::Integration::VendorIdentifier },
-                     api_name: :vendorIdentifier
-
-            # @!method initialize(id:, synced_entity_id:, vendor_identifier:)
-            #   @param id [String] Integration details
-            #
-            #   @param synced_entity_id [String, nil] Synced entity id
-            #
-            #   @param vendor_identifier [Symbol, Stigg::Models::V1::CustomerListResponse::Data::Integration::VendorIdentifier] The vendor identifier of integration
-
-            # The vendor identifier of integration
-            #
-            # @see Stigg::Models::V1::CustomerListResponse::Data::Integration#vendor_identifier
-            module VendorIdentifier
-              extend Stigg::Internal::Type::Enum
-
-              AUTH0 = :AUTH0
-              ZUORA = :ZUORA
-              STRIPE = :STRIPE
-              HUBSPOT = :HUBSPOT
-              AWS_MARKETPLACE = :AWS_MARKETPLACE
-              SNOWFLAKE = :SNOWFLAKE
-              SALESFORCE = :SALESFORCE
-              BIG_QUERY = :BIG_QUERY
-              OPEN_FGA = :OPEN_FGA
-              APP_STORE = :APP_STORE
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end

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

@@ -6,12 +6,15 @@ module Stigg
       # @see Stigg::Resources::V1::Customers#create
       class CustomerResponse < Stigg::Internal::Type::BaseModel
         # @!attribute data
+        #   A customer can be either an organization or an individual
         #
         #   @return [Stigg::Models::V1::CustomerResponse::Data]
         required :data, -> { Stigg::V1::CustomerResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [Stigg::Models::V1::CustomerResponse::Data]
+        #   Response object
+        #
+        #   @param data [Stigg::Models::V1::CustomerResponse::Data] A customer can be either an organization or an individual
 
         # @see Stigg::Models::V1::CustomerResponse#data
         class Data < Stigg::Internal::Type::BaseModel
@@ -80,6 +83,8 @@ module Stigg
           optional :name, String, nil?: true
 
           # @!method initialize(id:, archived_at:, created_at:, updated_at:, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, metadata: nil, name: nil)
+          #   A customer can be either an organization or an individual
+          #
           #   @param id [String] Customer slug
           #
           #   @param archived_at [Time, nil] Timestamp of when the record was deleted
@@ -182,6 +187,8 @@ module Stigg
                      api_name: :vendorIdentifier
 
             # @!method initialize(id:, synced_entity_id:, vendor_identifier:)
+            #   External billing or CRM integration link
+            #
             #   @param id [String] Integration details
             #
             #   @param synced_entity_id [String, nil] Synced entity id

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

@@ -74,6 +74,8 @@ module Stigg
                    api_name: :vendorIdentifier
 
           # @!method initialize(id:, synced_entity_id:, vendor_identifier:)
+          #   External billing or CRM integration link
+          #
           #   @param id [String] Integration details
           #
           #   @param synced_entity_id [String, nil] Synced entity id

data/lib/stigg/models/v1/customers/payment_method_attach_params.rb

@@ -30,6 +30,7 @@ module Stigg
                    api_name: :vendorIdentifier
 
           # @!attribute billing_currency
+          #   Customers selected currency
           #
           #   @return [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::BillingCurrency, nil]
           optional :billing_currency,
@@ -44,7 +45,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}]
 
@@ -67,6 +68,7 @@ module Stigg
             #   @return [Array<Symbol>]
           end
 
+          # Customers selected currency
           module BillingCurrency
             extend Stigg::Internal::Type::Enum