Class: Stigg::Models::V1::CustomerListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/customer_list_response.rb

Overview

See Also:

Defined Under Namespace

Modules: BillingCurrency, CouponID Classes: DefaultPaymentMethod, Integration, Passthrough

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, archived_at:, created_at:, updated_at:, billing_currency: nil, billing_id: nil, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, language: nil, metadata: nil, name: nil, passthrough: nil, timezone: nil) ⇒ Object

A customer can be either an organization or an individual

Parameters:

  • id (String) —

    Customer slug

  • archived_at (Time, nil) —

    Timestamp of when the record was deleted

  • created_at (Time) —

    Timestamp of when the record was created

  • updated_at (Time) —

    Timestamp of when the record was last updated

  • billing_currency (Symbol, Stigg::Models::V1::CustomerListResponse::BillingCurrency, nil) (defaults to: nil) —

    The billing currency of the customer

  • billing_id (String, nil) (defaults to: nil) —

    The unique identifier for the entity in the billing provider

  • coupon_id (String, Symbol, Stigg::Models::V1::CustomerListResponse::CouponID, nil) (defaults to: nil) —

    Customer level coupon

  • default_payment_method (Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod, nil) (defaults to: nil) —

    The default payment method details

  • email (String, nil) (defaults to: nil) —

    The email of the customer

  • integrations (Array<Stigg::Models::V1::CustomerListResponse::Integration>) (defaults to: nil) —

    List of integrations

  • language (String, nil) (defaults to: nil) —

    Language to use for this customer

  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

    Additional metadata

  • name (String, nil) (defaults to: nil) —

    The name of the customer

  • passthrough (Stigg::Models::V1::CustomerListResponse::Passthrough) (defaults to: nil) —

    Vendor-specific billing passthrough fields.

  • timezone (String, nil) (defaults to: nil) —

    Timezone to use for this customer




# File 'lib/stigg/models/v1/customer_list_response.rb', line 108

Instance Attribute Details

#archived_at ⇒ Time?

Timestamp of when the record was deleted

Returns:

  • (Time, nil) 


18
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 18

required :archived_at, Time, api_name: :archivedAt, nil?: true

#billing_currency ⇒ Symbol, ...

The billing currency of the customer

Returns:



36
37
38
39
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 36

optional :billing_currency,
enum: -> { Stigg::Models::V1::CustomerListResponse::BillingCurrency },
api_name: :billingCurrency,
nil?: true

#billing_id ⇒ String?

The unique identifier for the entity in the billing provider

Returns:

  • (String, nil) 


45
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 45

optional :billing_id, String, api_name: :billingId, nil?: true

#coupon_id ⇒ String, ...

Customer level coupon

Returns:



51
52
53
54
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 51

optional :coupon_id,
union: -> { Stigg::Models::V1::CustomerListResponse::CouponID },
api_name: :couponId,
nil?: true

#created_at ⇒ Time

Timestamp of when the record was created

Returns:

  • (Time) 


24
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 24

required :created_at, Time, api_name: :createdAt

#default_payment_method ⇒ Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod?

The default payment method details

Returns:



60
61
62
63
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 60

optional :default_payment_method,
-> { Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod },
api_name: :defaultPaymentMethod,
nil?: true

#email ⇒ String?

The email of the customer

Returns:

  • (String, nil) 


69
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 69

optional :email, String, nil?: true

#id ⇒ String

Customer slug

Returns:

  • (String) 


12
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 12

required :id, String

#integrations ⇒ Array<Stigg::Models::V1::CustomerListResponse::Integration>?

List of integrations

Returns:



75
76
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 75

optional :integrations,
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::CustomerListResponse::Integration] }

#language ⇒ String?

Language to use for this customer

Returns:

  • (String, nil) 


82
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 82

optional :language, String, nil?: true

#metadata ⇒ Hash{Symbol=>String}?

Additional metadata

Returns:

  • (Hash{Symbol=>String}, nil) 


88
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 88

optional :metadata, Stigg::Internal::Type::HashOf[String]

#name ⇒ String?

The name of the customer

Returns:

  • (String, nil) 


94
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 94

optional :name, String, nil?: true

#passthrough ⇒ Stigg::Models::V1::CustomerListResponse::Passthrough?

Vendor-specific billing passthrough fields.

Returns:



100
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 100

optional :passthrough, -> { Stigg::Models::V1::CustomerListResponse::Passthrough }

#timezone ⇒ String?

Timezone to use for this customer

Returns:

  • (String, nil) 


106
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 106

optional :timezone, String, nil?: true

#updated_at ⇒ Time

Timestamp of when the record was last updated

Returns:

  • (Time) 


30
 
# File 'lib/stigg/models/v1/customer_list_response.rb', line 30

required :updated_at, Time, api_name: :updatedAt

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/customer_list_response.rb', line 264