Class: ShopifyAPI::AbandonedCheckout

Inherits:
Rest::Base show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2022_07/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2022_10/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2023_01/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2023_04/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2023_07/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2023_10/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2024_01/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2024_04/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2024_07/abandoned_checkout.rb,
lib/shopify_api/rest/resources/2024_10/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

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

Constructor Details

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

Returns a new instance of AbandonedCheckout.



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
55
56
57
58
59
60
61
62
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 19

def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)

  @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))

  super(session: session, from_hash: from_hash)
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_url ⇒ Object (readonly)

Returns the value of attribute abandoned_checkout_url.



77
78
79
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 77

def abandoned_checkout_url
  @abandoned_checkout_url
end

#billing_address ⇒ Object (readonly)

Returns the value of attribute billing_address.



79
80
81
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 79

def billing_address
  @billing_address
end

#buyer_accepts_marketing ⇒ Object (readonly)

Returns the value of attribute buyer_accepts_marketing.



81
82
83
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 81

def buyer_accepts_marketing
  @buyer_accepts_marketing
end

#buyer_accepts_sms_marketing ⇒ Object (readonly)

Returns the value of attribute buyer_accepts_sms_marketing.



83
84
85
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 83

def buyer_accepts_sms_marketing
  @buyer_accepts_sms_marketing
end

#cart_token ⇒ Object (readonly)

Returns the value of attribute cart_token.



85
86
87
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 85

def cart_token
  @cart_token
end

#closed_at ⇒ Object (readonly)

Returns the value of attribute closed_at.



87
88
89
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 87

def closed_at
  @closed_at
end

#completed_at ⇒ Object (readonly)

Returns the value of attribute completed_at.



89
90
91
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 89

def completed_at
  @completed_at
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



91
92
93
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 91

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



93
94
95
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 93

def currency
  @currency
end

#customer ⇒ Object (readonly)

Returns the value of attribute customer.



95
96
97
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 95

def customer
  @customer
end

#customer_locale ⇒ Object (readonly)

Returns the value of attribute customer_locale.



97
98
99
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 97

def customer_locale
  @customer_locale
end

#device_id ⇒ Object (readonly)

Returns the value of attribute device_id.



99
100
101
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 99

def device_id
  @device_id
end

#discount_codes ⇒ Object (readonly)

Returns the value of attribute discount_codes.



101
102
103
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 101

def discount_codes
  @discount_codes
end

#email ⇒ Object (readonly)

Returns the value of attribute email.



103
104
105
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 103

def email
  @email
end

#gateway ⇒ Object (readonly)

Returns the value of attribute gateway.



105
106
107
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 105

def gateway
  @gateway
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



107
108
109
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 107

def id
  @id
end

#landing_site ⇒ Object (readonly)

Returns the value of attribute landing_site.



109
110
111
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 109

def landing_site
  @landing_site
end

#line_items ⇒ Object (readonly)

Returns the value of attribute line_items.



111
112
113
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 111

def line_items
  @line_items
end

#location_id ⇒ Object (readonly)

Returns the value of attribute location_id.



113
114
115
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 113

def location_id
  @location_id
end

#note ⇒ Object (readonly)

Returns the value of attribute note.



115
116
117
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 115

def note
  @note
end

#phone ⇒ Object (readonly)

Returns the value of attribute phone.



117
118
119
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 117

def phone
  @phone
end

#presentment_currency ⇒ Object (readonly)

Returns the value of attribute presentment_currency.



119
120
121
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 119

def presentment_currency
  @presentment_currency
end

#referring_site ⇒ Object (readonly)

Returns the value of attribute referring_site.



121
122
123
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 121

def referring_site
  @referring_site
end

#shipping_address ⇒ Object (readonly)

Returns the value of attribute shipping_address.



123
124
125
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 123

def shipping_address
  @shipping_address
end

#shipping_lines ⇒ Object (readonly)

Returns the value of attribute shipping_lines.



125
126
127
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 125

def shipping_lines
  @shipping_lines
end

#sms_marketing_phone ⇒ Object (readonly)

Returns the value of attribute sms_marketing_phone.



127
128
129
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 127

def sms_marketing_phone
  @sms_marketing_phone
end

#source_name ⇒ Object (readonly)

Returns the value of attribute source_name.



129
130
131
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 129

def source_name
  @source_name
end

#subtotal_price ⇒ Object (readonly)

Returns the value of attribute subtotal_price.



131
132
133
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 131

def subtotal_price
  @subtotal_price
end

#tax_lines ⇒ Object (readonly)

Returns the value of attribute tax_lines.



133
134
135
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 133

def tax_lines
  @tax_lines
end

#taxes_included ⇒ Object (readonly)

Returns the value of attribute taxes_included.



135
136
137
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 135

def taxes_included
  @taxes_included
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



137
138
139
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 137

def token
  @token
end

#total_discounts ⇒ Object (readonly)

Returns the value of attribute total_discounts.



139
140
141
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 139

def total_discounts
  @total_discounts
end

#total_duties ⇒ Object (readonly)

Returns the value of attribute total_duties.



141
142
143
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 141

def total_duties
  @total_duties
end

#total_line_items_price ⇒ Object (readonly)

Returns the value of attribute total_line_items_price.



143
144
145
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 143

def total_line_items_price
  @total_line_items_price
end

#total_price ⇒ Object (readonly)

Returns the value of attribute total_price.



145
146
147
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 145

def total_price
  @total_price
end

#total_tax ⇒ Object (readonly)

Returns the value of attribute total_tax.



147
148
149
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 147

def total_tax
  @total_tax
end

#total_weight ⇒ Object (readonly)

Returns the value of attribute total_weight.



149
150
151
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 149

def total_weight
  @total_weight
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



151
152
153
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 151

def updated_at
  @updated_at
end

#user_id ⇒ Object (readonly)

Returns the value of attribute user_id.



153
154
155
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 153

def user_id
  @user_id
end

Class Method Details

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb', line 169

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