stigg 0.1.0.pre.alpha.1

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      # @see Stigg::Resources::V1::Customers#update
+      class CustomerUpdateParams < Stigg::Internal::Type::BaseModel
+        extend Stigg::Internal::Type::RequestParameters::Converter
+        include Stigg::Internal::Type::RequestParameters
+
+        # @!attribute coupon_id
+        #   Customer level coupon
+        #
+        #   @return [String, nil]
+        optional :coupon_id, String, api_name: :couponId, nil?: true
+
+        # @!attribute email
+        #   The email of the customer
+        #
+        #   @return [String, nil]
+        optional :email, String, nil?: true
+
+        # @!attribute integrations
+        #   List of integrations
+        #
+        #   @return [Array<Stigg::Models::V1::CustomerUpdateParams::Integration>, nil]
+        optional :integrations,
+                 -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::CustomerUpdateParams::Integration] }
+
+        # @!attribute metadata
+        #   Additional metadata
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, Stigg::Internal::Type::HashOf[String]
+
+        # @!attribute name
+        #   The name of the customer
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(coupon_id: nil, email: nil, integrations: nil, metadata: nil, name: nil, request_options: {})
+        #   @param coupon_id [String, nil] Customer level coupon
+        #
+        #   @param email [String, nil] The email of the customer
+        #
+        #   @param integrations [Array<Stigg::Models::V1::CustomerUpdateParams::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}]
+
+        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::CustomerUpdateParams::Integration::VendorIdentifier]
+          required :vendor_identifier,
+                   enum: -> { Stigg::V1::CustomerUpdateParams::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::CustomerUpdateParams::Integration::VendorIdentifier] The vendor identifier of integration
+
+          # The vendor identifier of integration
+          #
+          # @see Stigg::Models::V1::CustomerUpdateParams::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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Customers
+        # @see Stigg::Resources::V1::Customers::PaymentMethod#attach
+        class PaymentMethodAttachParams < Stigg::Internal::Type::BaseModel
+          extend Stigg::Internal::Type::RequestParameters::Converter
+          include Stigg::Internal::Type::RequestParameters
+
+          # @!attribute integration_id
+          #   Integration details
+          #
+          #   @return [String]
+          required :integration_id, String, api_name: :integrationId
+
+          # @!attribute payment_method_id
+          #   Billing provider payment method id
+          #
+          #   @return [String]
+          required :payment_method_id, String, api_name: :paymentMethodId
+
+          # @!attribute vendor_identifier
+          #   The vendor identifier of integration
+          #
+          #   @return [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::VendorIdentifier]
+          required :vendor_identifier,
+                   enum: -> { Stigg::V1::Customers::PaymentMethodAttachParams::VendorIdentifier },
+                   api_name: :vendorIdentifier
+
+          # @!attribute billing_currency
+          #
+          #   @return [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::BillingCurrency, nil]
+          optional :billing_currency,
+                   enum: -> { Stigg::V1::Customers::PaymentMethodAttachParams::BillingCurrency },
+                   api_name: :billingCurrency,
+                   nil?: true
+
+          # @!method initialize(integration_id:, payment_method_id:, vendor_identifier:, billing_currency: nil, request_options: {})
+          #   @param integration_id [String] Integration details
+          #
+          #   @param payment_method_id [String] Billing provider payment method id
+          #
+          #   @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 request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+          # The vendor identifier of integration
+          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
+
+          module BillingCurrency
+            extend Stigg::Internal::Type::Enum
+
+            USD = :usd
+            AED = :aed
+            ALL = :all
+            AMD = :amd
+            ANG = :ang
+            AUD = :aud
+            AWG = :awg
+            AZN = :azn
+            BAM = :bam
+            BBD = :bbd
+            BDT = :bdt
+            BGN = :bgn
+            BIF = :bif
+            BMD = :bmd
+            BND = :bnd
+            BSD = :bsd
+            BWP = :bwp
+            BYN = :byn
+            BZD = :bzd
+            BRL = :brl
+            CAD = :cad
+            CDF = :cdf
+            CHF = :chf
+            CNY = :cny
+            CZK = :czk
+            DKK = :dkk
+            DOP = :dop
+            DZD = :dzd
+            EGP = :egp
+            ETB = :etb
+            EUR = :eur
+            FJD = :fjd
+            GBP = :gbp
+            GEL = :gel
+            GIP = :gip
+            GMD = :gmd
+            GYD = :gyd
+            HKD = :hkd
+            HRK = :hrk
+            HTG = :htg
+            IDR = :idr
+            ILS = :ils
+            INR = :inr
+            ISK = :isk
+            JMD = :jmd
+            JPY = :jpy
+            KES = :kes
+            KGS = :kgs
+            KHR = :khr
+            KMF = :kmf
+            KRW = :krw
+            KYD = :kyd
+            KZT = :kzt
+            LBP = :lbp
+            LKR = :lkr
+            LRD = :lrd
+            LSL = :lsl
+            MAD = :mad
+            MDL = :mdl
+            MGA = :mga
+            MKD = :mkd
+            MMK = :mmk
+            MNT = :mnt
+            MOP = :mop
+            MRO = :mro
+            MVR = :mvr
+            MWK = :mwk
+            MXN = :mxn
+            MYR = :myr
+            MZN = :mzn
+            NAD = :nad
+            NGN = :ngn
+            NOK = :nok
+            NPR = :npr
+            NZD = :nzd
+            PGK = :pgk
+            PHP = :php
+            PKR = :pkr
+            PLN = :pln
+            QAR = :qar
+            RON = :ron
+            RSD = :rsd
+            RUB = :rub
+            RWF = :rwf
+            SAR = :sar
+            SBD = :sbd
+            SCR = :scr
+            SEK = :sek
+            SGD = :sgd
+            SLE = :sle
+            SLL = :sll
+            SOS = :sos
+            SZL = :szl
+            THB = :thb
+            TJS = :tjs
+            TOP = :top
+            TRY = :try
+            TTD = :ttd
+            TZS = :tzs
+            UAH = :uah
+            UZS = :uzs
+            VND = :vnd
+            VUV = :vuv
+            WST = :wst
+            XAF = :xaf
+            XCD = :xcd
+            YER = :yer
+            ZAR = :zar
+            ZMW = :zmw
+            CLP = :clp
+            DJF = :djf
+            GNF = :gnf
+            UGX = :ugx
+            PYG = :pyg
+            XOF = :xof
+            XPF = :xpf
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Customers
+        # @see Stigg::Resources::V1::Customers::PaymentMethod#detach
+        class PaymentMethodDetachParams < Stigg::Internal::Type::BaseModel
+          extend Stigg::Internal::Type::RequestParameters::Converter
+          include Stigg::Internal::Type::RequestParameters
+
+          # @!method initialize(request_options: {})
+          #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,294 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Customers
+        # @see Stigg::Resources::V1::Customers::Promotional#create
+        class PromotionalCreateParams < Stigg::Internal::Type::BaseModel
+          extend Stigg::Internal::Type::RequestParameters::Converter
+          include Stigg::Internal::Type::RequestParameters
+
+          # @!attribute promotional_entitlements
+          #   Promotional entitlements to grant
+          #
+          #   @return [Array<Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement>]
+          required :promotional_entitlements,
+                   -> {
+                     Stigg::Internal::Type::ArrayOf[Stigg::V1::Customers::PromotionalCreateParams::PromotionalEntitlement]
+                   },
+                   api_name: :promotionalEntitlements
+
+          # @!method initialize(promotional_entitlements:, request_options: {})
+          #   @param promotional_entitlements [Array<Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement>] Promotional entitlements to grant
+          #
+          #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+          class PromotionalEntitlement < Stigg::Internal::Type::BaseModel
+            # @!attribute custom_end_date
+            #   The custom end date of the promotional entitlement
+            #
+            #   @return [Time, nil]
+            required :custom_end_date, Time, api_name: :customEndDate, nil?: true
+
+            # @!attribute enum_values
+            #   The enum values of the entitlement
+            #
+            #   @return [Array<String>, nil]
+            required :enum_values, Stigg::Internal::Type::ArrayOf[String], api_name: :enumValues, nil?: true
+
+            # @!attribute feature_id
+            #   The unique identifier of the entitlement feature
+            #
+            #   @return [String]
+            required :feature_id, String, api_name: :featureId
+
+            # @!attribute has_soft_limit
+            #   Whether the entitlement has a soft limit
+            #
+            #   @return [Boolean, nil]
+            required :has_soft_limit, Stigg::Internal::Type::Boolean, api_name: :hasSoftLimit, nil?: true
+
+            # @!attribute has_unlimited_usage
+            #   Whether the entitlement has an unlimited usage
+            #
+            #   @return [Boolean, nil]
+            required :has_unlimited_usage,
+                     Stigg::Internal::Type::Boolean,
+                     api_name: :hasUnlimitedUsage,
+                     nil?: true
+
+            # @!attribute is_visible
+            #   Whether the entitlement is visible
+            #
+            #   @return [Boolean, nil]
+            required :is_visible, Stigg::Internal::Type::Boolean, api_name: :isVisible, nil?: true
+
+            # @!attribute monthly_reset_period_configuration
+            #   The monthly reset period configuration of the entitlement, defined when reset
+            #   period is monthly
+            #
+            #   @return [Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::MonthlyResetPeriodConfiguration, nil]
+            required :monthly_reset_period_configuration,
+                     -> {
+                       Stigg::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::MonthlyResetPeriodConfiguration
+                     },
+                     api_name: :monthlyResetPeriodConfiguration,
+                     nil?: true
+
+            # @!attribute period
+            #   The grant period of the promotional entitlement
+            #
+            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::Period]
+            required :period,
+                     enum: -> { Stigg::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::Period }
+
+            # @!attribute reset_period
+            #   The reset period of the entitlement
+            #
+            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::ResetPeriod, nil]
+            required :reset_period,
+                     enum: -> {
+                       Stigg::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::ResetPeriod
+                     },
+                     api_name: :resetPeriod,
+                     nil?: true
+
+            # @!attribute usage_limit
+            #   The usage limit of the entitlement
+            #
+            #   @return [Integer, nil]
+            required :usage_limit, Integer, api_name: :usageLimit, nil?: true
+
+            # @!attribute weekly_reset_period_configuration
+            #   The weekly reset period configuration of the entitlement, defined when reset
+            #   period is weekly
+            #
+            #   @return [Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::WeeklyResetPeriodConfiguration, nil]
+            required :weekly_reset_period_configuration,
+                     -> {
+                       Stigg::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::WeeklyResetPeriodConfiguration
+                     },
+                     api_name: :weeklyResetPeriodConfiguration,
+                     nil?: true
+
+            # @!attribute yearly_reset_period_configuration
+            #   The yearly reset period configuration of the entitlement, defined when reset
+            #   period is yearly
+            #
+            #   @return [Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::YearlyResetPeriodConfiguration, nil]
+            required :yearly_reset_period_configuration,
+                     -> {
+                       Stigg::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::YearlyResetPeriodConfiguration
+                     },
+                     api_name: :yearlyResetPeriodConfiguration,
+                     nil?: true
+
+            # @!method initialize(custom_end_date:, enum_values:, feature_id:, has_soft_limit:, has_unlimited_usage:, is_visible:, monthly_reset_period_configuration:, period:, reset_period:, usage_limit:, weekly_reset_period_configuration:, yearly_reset_period_configuration:)
+            #   Some parameter documentations has been truncated, see
+            #   {Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement}
+            #   for more details.
+            #
+            #   @param custom_end_date [Time, nil] The custom end date of the promotional entitlement
+            #
+            #   @param enum_values [Array<String>, nil] The enum values of the entitlement
+            #
+            #   @param feature_id [String] The unique identifier of the entitlement feature
+            #
+            #   @param has_soft_limit [Boolean, nil] Whether the entitlement has a soft limit
+            #
+            #   @param has_unlimited_usage [Boolean, nil] Whether the entitlement has an unlimited usage
+            #
+            #   @param is_visible [Boolean, nil] Whether the entitlement is visible
+            #
+            #   @param monthly_reset_period_configuration [Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::MonthlyResetPeriodConfiguration, nil] The monthly reset period configuration of the entitlement, defined when reset pe
+            #
+            #   @param period [Symbol, Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::Period] The grant period of the promotional entitlement
+            #
+            #   @param reset_period [Symbol, Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::ResetPeriod, nil] The reset period of the entitlement
+            #
+            #   @param usage_limit [Integer, nil] The usage limit of the entitlement
+            #
+            #   @param weekly_reset_period_configuration [Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::WeeklyResetPeriodConfiguration, nil] The weekly reset period configuration of the entitlement, defined when reset per
+            #
+            #   @param yearly_reset_period_configuration [Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::YearlyResetPeriodConfiguration, nil] The yearly reset period configuration of the entitlement, defined when reset per
+
+            # @see Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement#monthly_reset_period_configuration
+            class MonthlyResetPeriodConfiguration < Stigg::Internal::Type::BaseModel
+              # @!attribute according_to
+              #   Monthly reset period according to
+              #
+              #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::MonthlyResetPeriodConfiguration::AccordingTo]
+              required :according_to,
+                       enum: -> {
+                         Stigg::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::MonthlyResetPeriodConfiguration::AccordingTo
+                       },
+                       api_name: :accordingTo
+
+              # @!method initialize(according_to:)
+              #   The monthly reset period configuration of the entitlement, defined when reset
+              #   period is monthly
+              #
+              #   @param according_to [Symbol, Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::MonthlyResetPeriodConfiguration::AccordingTo] Monthly reset period according to
+
+              # Monthly reset period according to
+              #
+              # @see Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::MonthlyResetPeriodConfiguration#according_to
+              module AccordingTo
+                extend Stigg::Internal::Type::Enum
+
+                SUBSCRIPTION_START = :SubscriptionStart
+                START_OF_THE_MONTH = :StartOfTheMonth
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # The grant period of the promotional entitlement
+            #
+            # @see Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement#period
+            module Period
+              extend Stigg::Internal::Type::Enum
+
+              PERIOD_1_WEEK = :"1 week"
+              PERIOD_1_MONTH = :"1 month"
+              PERIOD_6_MONTH = :"6 month"
+              PERIOD_1_YEAR = :"1 year"
+              LIFETIME = :lifetime
+              CUSTOM = :custom
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The reset period of the entitlement
+            #
+            # @see Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement#reset_period
+            module ResetPeriod
+              extend Stigg::Internal::Type::Enum
+
+              YEAR = :YEAR
+              MONTH = :MONTH
+              WEEK = :WEEK
+              DAY = :DAY
+              HOUR = :HOUR
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement#weekly_reset_period_configuration
+            class WeeklyResetPeriodConfiguration < Stigg::Internal::Type::BaseModel
+              # @!attribute according_to
+              #   Weekly reset period according to
+              #
+              #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::WeeklyResetPeriodConfiguration::AccordingTo]
+              required :according_to,
+                       enum: -> {
+                         Stigg::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::WeeklyResetPeriodConfiguration::AccordingTo
+                       },
+                       api_name: :accordingTo
+
+              # @!method initialize(according_to:)
+              #   The weekly reset period configuration of the entitlement, defined when reset
+              #   period is weekly
+              #
+              #   @param according_to [Symbol, Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::WeeklyResetPeriodConfiguration::AccordingTo] Weekly reset period according to
+
+              # Weekly reset period according to
+              #
+              # @see Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::WeeklyResetPeriodConfiguration#according_to
+              module AccordingTo
+                extend Stigg::Internal::Type::Enum
+
+                SUBSCRIPTION_START = :SubscriptionStart
+                EVERY_SUNDAY = :EverySunday
+                EVERY_MONDAY = :EveryMonday
+                EVERY_TUESDAY = :EveryTuesday
+                EVERY_WEDNESDAY = :EveryWednesday
+                EVERY_THURSDAY = :EveryThursday
+                EVERY_FRIDAY = :EveryFriday
+                EVERY_SATURDAY = :EverySaturday
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # @see Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement#yearly_reset_period_configuration
+            class YearlyResetPeriodConfiguration < Stigg::Internal::Type::BaseModel
+              # @!attribute according_to
+              #   Yearly reset period according to
+              #
+              #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::YearlyResetPeriodConfiguration::AccordingTo]
+              required :according_to,
+                       enum: -> {
+                         Stigg::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::YearlyResetPeriodConfiguration::AccordingTo
+                       },
+                       api_name: :accordingTo
+
+              # @!method initialize(according_to:)
+              #   The yearly reset period configuration of the entitlement, defined when reset
+              #   period is yearly
+              #
+              #   @param according_to [Symbol, Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::YearlyResetPeriodConfiguration::AccordingTo] Yearly reset period according to
+
+              # Yearly reset period according to
+              #
+              # @see Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::YearlyResetPeriodConfiguration#according_to
+              module AccordingTo
+                extend Stigg::Internal::Type::Enum
+
+                SUBSCRIPTION_START = :SubscriptionStart
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end