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

data/rbi/stigg/models/v1/{customer_create_params.rbi → customer_provision_params.rbi}

@@ -3,13 +3,13 @@
 module Stigg
   module Models
     module V1
-      class CustomerCreateParams < Stigg::Internal::Type::BaseModel
+      class CustomerProvisionParams < Stigg::Internal::Type::BaseModel
         extend Stigg::Internal::Type::RequestParameters::Converter
         include Stigg::Internal::Type::RequestParameters
 
         OrHash =
           T.type_alias do
-            T.any(Stigg::V1::CustomerCreateParams, Stigg::Internal::AnyHash)
+            T.any(Stigg::V1::CustomerProvisionParams, Stigg::Internal::AnyHash)
           end
 
         # Customer slug
@@ -23,7 +23,7 @@ module Stigg
         # The default payment method details
         sig do
           returns(
-            T.nilable(Stigg::V1::CustomerCreateParams::DefaultPaymentMethod)
+            T.nilable(Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod)
           )
         end
         attr_reader :default_payment_method
@@ -32,7 +32,7 @@ module Stigg
           params(
             default_payment_method:
               T.nilable(
-                Stigg::V1::CustomerCreateParams::DefaultPaymentMethod::OrHash
+                Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::OrHash
               )
           ).void
         end
@@ -45,7 +45,7 @@ module Stigg
         # List of integrations
         sig do
           returns(
-            T.nilable(T::Array[Stigg::V1::CustomerCreateParams::Integration])
+            T.nilable(T::Array[Stigg::V1::CustomerProvisionParams::Integration])
           )
         end
         attr_reader :integrations
@@ -53,7 +53,7 @@ module Stigg
         sig do
           params(
             integrations:
-              T::Array[Stigg::V1::CustomerCreateParams::Integration::OrHash]
+              T::Array[Stigg::V1::CustomerProvisionParams::Integration::OrHash]
           ).void
         end
         attr_writer :integrations
@@ -75,11 +75,11 @@ module Stigg
             coupon_id: T.nilable(String),
             default_payment_method:
               T.nilable(
-                Stigg::V1::CustomerCreateParams::DefaultPaymentMethod::OrHash
+                Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::OrHash
               ),
             email: T.nilable(String),
             integrations:
-              T::Array[Stigg::V1::CustomerCreateParams::Integration::OrHash],
+              T::Array[Stigg::V1::CustomerProvisionParams::Integration::OrHash],
             metadata: T::Hash[Symbol, String],
             name: T.nilable(String),
             request_options: Stigg::RequestOptions::OrHash
@@ -111,11 +111,11 @@ module Stigg
               coupon_id: T.nilable(String),
               default_payment_method:
                 T.nilable(
-                  Stigg::V1::CustomerCreateParams::DefaultPaymentMethod
+                  Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod
                 ),
               email: T.nilable(String),
               integrations:
-                T::Array[Stigg::V1::CustomerCreateParams::Integration],
+                T::Array[Stigg::V1::CustomerProvisionParams::Integration],
               metadata: T::Hash[Symbol, String],
               name: T.nilable(String),
               request_options: Stigg::RequestOptions
@@ -129,7 +129,7 @@ module Stigg
           OrHash =
             T.type_alias do
               T.any(
-                Stigg::V1::CustomerCreateParams::DefaultPaymentMethod,
+                Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod,
                 Stigg::Internal::AnyHash
               )
             end
@@ -153,7 +153,7 @@ module Stigg
           # The default payment method type
           sig do
             returns(
-              Stigg::V1::CustomerCreateParams::DefaultPaymentMethod::Type::OrSymbol
+              Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::Type::OrSymbol
             )
           end
           attr_accessor :type
@@ -166,7 +166,7 @@ module Stigg
               card_expiry_year: T.nilable(Float),
               card_last4_digits: T.nilable(String),
               type:
-                Stigg::V1::CustomerCreateParams::DefaultPaymentMethod::Type::OrSymbol
+                Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::Type::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
@@ -191,7 +191,7 @@ module Stigg
                 card_expiry_year: T.nilable(Float),
                 card_last4_digits: T.nilable(String),
                 type:
-                  Stigg::V1::CustomerCreateParams::DefaultPaymentMethod::Type::OrSymbol
+                  Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::Type::OrSymbol
               }
             )
           end
@@ -206,7 +206,7 @@ module Stigg
               T.type_alias do
                 T.all(
                   Symbol,
-                  Stigg::V1::CustomerCreateParams::DefaultPaymentMethod::Type
+                  Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::Type
                 )
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -214,23 +214,23 @@ module Stigg
             CARD =
               T.let(
                 :CARD,
-                Stigg::V1::CustomerCreateParams::DefaultPaymentMethod::Type::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::Type::TaggedSymbol
               )
             BANK =
               T.let(
                 :BANK,
-                Stigg::V1::CustomerCreateParams::DefaultPaymentMethod::Type::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::Type::TaggedSymbol
               )
             CASH_APP =
               T.let(
                 :CASH_APP,
-                Stigg::V1::CustomerCreateParams::DefaultPaymentMethod::Type::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::Type::TaggedSymbol
               )
 
             sig do
               override.returns(
                 T::Array[
-                  Stigg::V1::CustomerCreateParams::DefaultPaymentMethod::Type::TaggedSymbol
+                  Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::Type::TaggedSymbol
                 ]
               )
             end
@@ -243,7 +243,7 @@ module Stigg
           OrHash =
             T.type_alias do
               T.any(
-                Stigg::V1::CustomerCreateParams::Integration,
+                Stigg::V1::CustomerProvisionParams::Integration,
                 Stigg::Internal::AnyHash
               )
             end
@@ -259,17 +259,18 @@ module Stigg
           # The vendor identifier of integration
           sig do
             returns(
-              Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::OrSymbol
+              Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::OrSymbol
             )
           end
           attr_accessor :vendor_identifier
 
+          # External billing or CRM integration link
           sig do
             params(
               id: String,
               synced_entity_id: T.nilable(String),
               vendor_identifier:
-                Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::OrSymbol
+                Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
@@ -288,7 +289,7 @@ module Stigg
                 id: String,
                 synced_entity_id: T.nilable(String),
                 vendor_identifier:
-                  Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::OrSymbol
+                  Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::OrSymbol
               }
             )
           end
@@ -303,7 +304,7 @@ module Stigg
               T.type_alias do
                 T.all(
                   Symbol,
-                  Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier
+                  Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier
                 )
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -311,58 +312,58 @@ module Stigg
             AUTH0 =
               T.let(
                 :AUTH0,
-                Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::TaggedSymbol
               )
             ZUORA =
               T.let(
                 :ZUORA,
-                Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::TaggedSymbol
               )
             STRIPE =
               T.let(
                 :STRIPE,
-                Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::TaggedSymbol
               )
             HUBSPOT =
               T.let(
                 :HUBSPOT,
-                Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::TaggedSymbol
               )
             AWS_MARKETPLACE =
               T.let(
                 :AWS_MARKETPLACE,
-                Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::TaggedSymbol
               )
             SNOWFLAKE =
               T.let(
                 :SNOWFLAKE,
-                Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::TaggedSymbol
               )
             SALESFORCE =
               T.let(
                 :SALESFORCE,
-                Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::TaggedSymbol
               )
             BIG_QUERY =
               T.let(
                 :BIG_QUERY,
-                Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::TaggedSymbol
               )
             OPEN_FGA =
               T.let(
                 :OPEN_FGA,
-                Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::TaggedSymbol
               )
             APP_STORE =
               T.let(
                 :APP_STORE,
-                Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::TaggedSymbol
+                Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::TaggedSymbol
               )
 
             sig do
               override.returns(
                 T::Array[
-                  Stigg::V1::CustomerCreateParams::Integration::VendorIdentifier::TaggedSymbol
+                  Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier::TaggedSymbol
                 ]
               )
             end

data/rbi/stigg/models/v1/customer_response.rbi

@@ -9,18 +9,23 @@ module Stigg
             T.any(Stigg::V1::CustomerResponse, Stigg::Internal::AnyHash)
           end
 
+        # A customer can be either an organization or an individual
         sig { returns(Stigg::V1::CustomerResponse::Data) }
         attr_reader :data
 
         sig { params(data: Stigg::V1::CustomerResponse::Data::OrHash).void }
         attr_writer :data
 
+        # Response object
         sig do
           params(data: Stigg::V1::CustomerResponse::Data::OrHash).returns(
             T.attached_class
           )
         end
-        def self.new(data:)
+        def self.new(
+          # A customer can be either an organization or an individual
+          data:
+        )
         end
 
         sig { override.returns({ data: Stigg::V1::CustomerResponse::Data }) }
@@ -104,6 +109,7 @@ module Stigg
           sig { returns(T.nilable(String)) }
           attr_accessor :name
 
+          # A customer can be either an organization or an individual
           sig do
             params(
               id: String,
@@ -310,6 +316,7 @@ module Stigg
             end
             attr_accessor :vendor_identifier
 
+            # External billing or CRM integration link
             sig do
               params(
                 id: String,

data/rbi/stigg/models/v1/customer_update_params.rbi

@@ -114,6 +114,7 @@ module Stigg
           end
           attr_accessor :vendor_identifier
 
+          # External billing or CRM integration link
           sig do
             params(
               id: String,

data/rbi/stigg/models/v1/customers/payment_method_attach_params.rbi

@@ -32,6 +32,7 @@ module Stigg
           end
           attr_accessor :vendor_identifier
 
+          # Customers selected currency
           sig do
             returns(
               T.nilable(
@@ -61,6 +62,7 @@ module Stigg
             payment_method_id:,
             # The vendor identifier of integration
             vendor_identifier:,
+            # Customers selected currency
             billing_currency: nil,
             request_options: {}
           )
@@ -159,6 +161,7 @@ module Stigg
             end
           end
 
+          # Customers selected currency
           module BillingCurrency
             extend Stigg::Internal::Type::Enum