Class: ShopifyAPI::Transaction

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

Returns a new instance of Transaction.



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
 
# File 'lib/shopify_api/rest/resources/2021_07/transaction.rb', line 16

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

  @kind = T.let(nil, T.nilable(String))
  @amount = T.let(nil, T.nilable(String))
  @authorization = T.let(nil, T.nilable(String))
  @authorization_expires_at = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @currency = T.let(nil, T.nilable(String))
  @currency_exchange_adjustment = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @device_id = T.let(nil, T.nilable(Integer))
  @error_code = T.let(nil, T.nilable(String))
  @extended_authorization_attributes = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @gateway = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @location_id = T.let(nil, T.nilable(Integer))
  @message = T.let(nil, T.nilable(String))
  @order_id = T.let(nil, T.nilable(Integer))
  @parent_id = T.let(nil, T.nilable(Integer))
  @payment_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @processed_at = T.let(nil, T.nilable(String))
  @receipt = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @source_name = T.let(nil, T.nilable(String))
  @status = T.let(nil, T.nilable(String))
  @test = T.let(nil, T.nilable(T::Boolean))
  @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

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



56
57
58
 
# File 'lib/shopify_api/rest/resources/2021_07/transaction.rb', line 56

def amount
  @amount
end

#authorization ⇒ Object (readonly)

Returns the value of attribute authorization.



58
59
60
 
# File 'lib/shopify_api/rest/resources/2021_07/transaction.rb', line 58

def authorization
  @authorization
end

#authorization_expires_at ⇒ Object (readonly)

Returns the value of attribute authorization_expires_at.



60
61
62
 
# File 'lib/shopify_api/rest/resources/2021_07/transaction.rb', line 60

def authorization_expires_at
  @authorization_expires_at
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



62
63
64
 
# File 'lib/shopify_api/rest/resources/2021_07/transaction.rb', line 62

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



64
65
66
 
# File 'lib/shopify_api/rest/resources/2021_07/transaction.rb', line 64

def currency
  @currency
end

#currency_exchange_adjustment ⇒ Object (readonly)

Returns the value of attribute currency_exchange_adjustment.



66
67
68
 
# File 'lib/shopify_api/rest/resources/2021_07/transaction.rb', line 66

def currency_exchange_adjustment
  @currency_exchange_adjustment
end

#device_id ⇒ Object (readonly)

Returns the value of attribute device_id.



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

def device_id
  @device_id
end

#error_code ⇒ Object (readonly)

Returns the value of attribute error_code.



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

def error_code
  @error_code
end

#extended_authorization_attributes ⇒ Object (readonly)

Returns the value of attribute extended_authorization_attributes.



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

def extended_authorization_attributes
  @extended_authorization_attributes
end

#gateway ⇒ Object (readonly)

Returns the value of attribute gateway.



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

def gateway
  @gateway
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#kind ⇒ Object (readonly)

Returns the value of attribute kind.



54
55
56
 
# File 'lib/shopify_api/rest/resources/2021_07/transaction.rb', line 54

def kind
  @kind
end

#location_id ⇒ Object (readonly)

Returns the value of attribute location_id.



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

def location_id
  @location_id
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



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

def message
  @message
end

#order_id ⇒ Object (readonly)

Returns the value of attribute order_id.



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

def order_id
  @order_id
end

#parent_id ⇒ Object (readonly)

Returns the value of attribute parent_id.



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

def parent_id
  @parent_id
end

#payment_details ⇒ Object (readonly)

Returns the value of attribute payment_details.



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

def payment_details
  @payment_details
end

#payments_refund_attributes ⇒ Object (readonly)

Returns the value of attribute payments_refund_attributes.



89
90
91
 
# File 'lib/shopify_api/rest/resources/2021_10/transaction.rb', line 89

def payments_refund_attributes
  @payments_refund_attributes
end

#processed_at ⇒ Object (readonly)

Returns the value of attribute processed_at.



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

def processed_at
  @processed_at
end

#receipt ⇒ Object (readonly)

Returns the value of attribute receipt.



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

def receipt
  @receipt
end

#source_name ⇒ Object (readonly)

Returns the value of attribute source_name.



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

def source_name
  @source_name
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



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

def status
  @status
end

#test ⇒ Object (readonly)

Returns the value of attribute test.



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

def test
  @test
end

#user_id ⇒ Object (readonly)

Returns the value of attribute user_id.



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

def user_id
  @user_id
end

Class Method Details

.all(order_id: nil, since_id: nil, fields: nil, in_shop_currency: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/shopify_api/rest/resources/2021_07/transaction.rb', line 135

def all(
  order_id: nil,
  since_id: nil,
  fields: nil,
  in_shop_currency: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {order_id: order_id},
    params: {since_id: since_id, fields: fields, in_shop_currency: in_shop_currency}.merge(kwargs).compact,
  )

  T.cast(response, T::Array[Transaction])
end

.count(order_id: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/shopify_api/rest/resources/2021_07/transaction.rb', line 159

def count(
  order_id: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :count,
    session: session,
    ids: {order_id: order_id},
    params: {}.merge(kwargs).compact,
    body: {},
    entity: nil,
  )
end

.find(id:, order_id: nil, fields: nil, in_shop_currency: nil, session: ShopifyAPI::Context.active_session) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/shopify_api/rest/resources/2021_07/transaction.rb', line 110

def find(
  id:,
  order_id: nil,
  fields: nil,
  in_shop_currency: nil,
  session: ShopifyAPI::Context.active_session
)
  result = base_find(
    session: session,
    ids: {id: id, order_id: order_id},
    params: {fields: fields, in_shop_currency: in_shop_currency},
  )
  T.cast(result[0], T.nilable(Transaction))
end