Class: ShopifyAPI::AbandonedCheckout

Inherits:
Rest::Base show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2021_10/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2022_01/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb

Instance Attribute Summary collapse

Attributes inherited from Rest::Base

#errors, #original_state

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Rest::Base

base_find, class_name, create_instance, create_instances_from_response, #delete, get_path, has_many?, has_one?, json_body_name, #method_missing, next_page?, next_page_info, prev_page?, prev_page_info, primary_key, read_only_attributes, request, #respond_to_missing?, #save, #save!, #to_hash

Constructor Details

#initialize(session: ShopifyAPI::Context.active_session) ⇒ AbandonedCheckout

Returns a new instance of AbandonedCheckout.


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 12

def initialize(session: ShopifyAPI::Context.active_session)
  super(session: session)

  @abandoned_checkout_url = T.let(nil, T.nilable(String))
  @billing_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @buyer_accepts_marketing = T.let(nil, T.nilable(T::Boolean))
  @buyer_accepts_sms_marketing = T.let(nil, T.nilable(T::Boolean))
  @cart_token = T.let(nil, T.nilable(String))
  @closed_at = T.let(nil, T.nilable(String))
  @completed_at = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @currency = T.let(nil, T.nilable(Currency))
  @customer = T.let(nil, T.nilable(Customer))
  @customer_locale = T.let(nil, T.nilable(String))
  @device_id = T.let(nil, T.nilable(Integer))
  @discount_codes = T.let(nil, T.nilable(T::Array[T.untyped]))
  @email = T.let(nil, T.nilable(String))
  @gateway = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @landing_site = T.let(nil, T.nilable(String))
  @line_items = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @location_id = T.let(nil, T.nilable(Integer))
  @note = T.let(nil, T.nilable(String))
  @phone = T.let(nil, T.nilable(String))
  @presentment_currency = T.let(nil, T.nilable(String))
  @referring_site = T.let(nil, T.nilable(String))
  @shipping_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @shipping_lines = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @sms_marketing_phone = T.let(nil, T.nilable(String))
  @source_name = T.let(nil, T.nilable(String))
  @subtotal_price = T.let(nil, T.nilable(String))
  @tax_lines = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @taxes_included = T.let(nil, T.nilable(T::Boolean))
  @token = T.let(nil, T.nilable(String))
  @total_discounts = T.let(nil, T.nilable(String))
  @total_duties = T.let(nil, T.nilable(String))
  @total_line_items_price = T.let(nil, T.nilable(String))
  @total_price = T.let(nil, T.nilable(String))
  @total_tax = T.let(nil, T.nilable(String))
  @total_weight = T.let(nil, T.nilable(Integer))
  @updated_at = T.let(nil, T.nilable(String))
  @user_id = T.let(nil, T.nilable(Integer))
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ShopifyAPI::Rest::Base

Instance Attribute Details

#abandoned_checkout_urlObject (readonly)

Returns the value of attribute abandoned_checkout_url.


68
69
70
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 68

def abandoned_checkout_url
  @abandoned_checkout_url
end

#billing_addressObject (readonly)

Returns the value of attribute billing_address.


70
71
72
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 70

def billing_address
  @billing_address
end

#buyer_accepts_marketingObject (readonly)

Returns the value of attribute buyer_accepts_marketing.


72
73
74
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 72

def buyer_accepts_marketing
  @buyer_accepts_marketing
end

#buyer_accepts_sms_marketingObject (readonly)

Returns the value of attribute buyer_accepts_sms_marketing.


74
75
76
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 74

def buyer_accepts_sms_marketing
  @buyer_accepts_sms_marketing
end

#cart_tokenObject (readonly)

Returns the value of attribute cart_token.


76
77
78
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 76

def cart_token
  @cart_token
end

#closed_atObject (readonly)

Returns the value of attribute closed_at.


78
79
80
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 78

def closed_at
  @closed_at
end

#completed_atObject (readonly)

Returns the value of attribute completed_at.


80
81
82
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 80

def completed_at
  @completed_at
end

#created_atObject (readonly)

Returns the value of attribute created_at.


82
83
84
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 82

def created_at
  @created_at
end

#currencyObject (readonly)

Returns the value of attribute currency.


84
85
86
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 84

def currency
  @currency
end

#customerObject (readonly)

Returns the value of attribute customer.


86
87
88
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 86

def customer
  @customer
end

#customer_localeObject (readonly)

Returns the value of attribute customer_locale.


88
89
90
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 88

def customer_locale
  @customer_locale
end

#device_idObject (readonly)

Returns the value of attribute device_id.


90
91
92
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 90

def device_id
  @device_id
end

#discount_codesObject (readonly)

Returns the value of attribute discount_codes.


92
93
94
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 92

def discount_codes
  @discount_codes
end

#emailObject (readonly)

Returns the value of attribute email.


94
95
96
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 94

def email
  @email
end

#gatewayObject (readonly)

Returns the value of attribute gateway.


96
97
98
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 96

def gateway
  @gateway
end

#idObject (readonly)

Returns the value of attribute id.


98
99
100
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 98

def id
  @id
end

#landing_siteObject (readonly)

Returns the value of attribute landing_site.


100
101
102
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 100

def landing_site
  @landing_site
end

#line_itemsObject (readonly)

Returns the value of attribute line_items.


102
103
104
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 102

def line_items
  @line_items
end

#location_idObject (readonly)

Returns the value of attribute location_id.


104
105
106
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 104

def location_id
  @location_id
end

#noteObject (readonly)

Returns the value of attribute note.


106
107
108
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 106

def note
  @note
end

#phoneObject (readonly)

Returns the value of attribute phone.


108
109
110
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 108

def phone
  @phone
end

#presentment_currencyObject (readonly)

Returns the value of attribute presentment_currency.


110
111
112
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 110

def presentment_currency
  @presentment_currency
end

#referring_siteObject (readonly)

Returns the value of attribute referring_site.


112
113
114
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 112

def referring_site
  @referring_site
end

#shipping_addressObject (readonly)

Returns the value of attribute shipping_address.


114
115
116
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 114

def shipping_address
  @shipping_address
end

#shipping_linesObject (readonly)

Returns the value of attribute shipping_lines.


116
117
118
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 116

def shipping_lines
  @shipping_lines
end

#sms_marketing_phoneObject (readonly)

Returns the value of attribute sms_marketing_phone.


118
119
120
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 118

def sms_marketing_phone
  @sms_marketing_phone
end

#source_nameObject (readonly)

Returns the value of attribute source_name.


120
121
122
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 120

def source_name
  @source_name
end

#subtotal_priceObject (readonly)

Returns the value of attribute subtotal_price.


122
123
124
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 122

def subtotal_price
  @subtotal_price
end

#tax_linesObject (readonly)

Returns the value of attribute tax_lines.


124
125
126
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 124

def tax_lines
  @tax_lines
end

#taxes_includedObject (readonly)

Returns the value of attribute taxes_included.


126
127
128
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 126

def taxes_included
  @taxes_included
end

#tokenObject (readonly)

Returns the value of attribute token.


128
129
130
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 128

def token
  @token
end

#total_discountsObject (readonly)

Returns the value of attribute total_discounts.


130
131
132
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 130

def total_discounts
  @total_discounts
end

#total_dutiesObject (readonly)

Returns the value of attribute total_duties.


132
133
134
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 132

def total_duties
  @total_duties
end

#total_line_items_priceObject (readonly)

Returns the value of attribute total_line_items_price.


134
135
136
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 134

def total_line_items_price
  @total_line_items_price
end

#total_priceObject (readonly)

Returns the value of attribute total_price.


136
137
138
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 136

def total_price
  @total_price
end

#total_taxObject (readonly)

Returns the value of attribute total_tax.


138
139
140
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 138

def total_tax
  @total_tax
end

#total_weightObject (readonly)

Returns the value of attribute total_weight.


140
141
142
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 140

def total_weight
  @total_weight
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


142
143
144
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 142

def updated_at
  @updated_at
end

#user_idObject (readonly)

Returns the value of attribute user_id.


144
145
146
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 144

def user_id
  @user_id
end

Class Method Details

.checkouts(limit: nil, since_id: nil, created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, status: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object


160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb', line 160

def checkouts(
  limit: nil,
  since_id: nil,
  created_at_min: nil,
  created_at_max: nil,
  updated_at_min: nil,
  updated_at_max: nil,
  status: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :checkouts,
    session: session,
    ids: {},
    params: {limit: limit, since_id: since_id, created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max, status: status}.merge(kwargs).compact,
    body: {},
    entity: nil,
  )
end