Class: ShopifyAPI::Payment

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

Constructor Details

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

Returns a new instance of Payment.



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/shopify_api/rest/resources/2022_04/payment.rb', line 16

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

  @checkout = T.let(nil, T.nilable(Checkout))
  @credit_card = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @id = T.let(nil, T.nilable(Integer))
  @next_action = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @payment_processing_error_message = T.let(nil, T.nilable(String))
  @transaction = T.let(nil, T.nilable(Transaction))
  @unique_token = T.let(nil, T.nilable(String))
end

Dynamic Method Handling

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

Instance Attribute Details

#checkout ⇒ Object (readonly)

Returns the value of attribute checkout.



41
42
43
 
# File 'lib/shopify_api/rest/resources/2022_04/payment.rb', line 41

def checkout
  @checkout
end

#credit_card ⇒ Object (readonly)

Returns the value of attribute credit_card.



43
44
45
 
# File 'lib/shopify_api/rest/resources/2022_04/payment.rb', line 43

def credit_card
  @credit_card
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



45
46
47
 
# File 'lib/shopify_api/rest/resources/2022_04/payment.rb', line 45

def id
  @id
end

#next_action ⇒ Object (readonly)

Returns the value of attribute next_action.



47
48
49
 
# File 'lib/shopify_api/rest/resources/2022_04/payment.rb', line 47

def next_action
  @next_action
end

#payment_processing_error_message ⇒ Object (readonly)

Returns the value of attribute payment_processing_error_message.



49
50
51
 
# File 'lib/shopify_api/rest/resources/2022_04/payment.rb', line 49

def payment_processing_error_message
  @payment_processing_error_message
end

#transaction ⇒ Object (readonly)

Returns the value of attribute transaction.



51
52
53
 
# File 'lib/shopify_api/rest/resources/2022_04/payment.rb', line 51

def transaction
  @transaction
end

#unique_token ⇒ Object (readonly)

Returns the value of attribute unique_token.



53
54
55
 
# File 'lib/shopify_api/rest/resources/2022_04/payment.rb', line 53

def unique_token
  @unique_token
end

Class Method Details

.all(checkout_id: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/shopify_api/rest/resources/2022_04/payment.rb', line 83

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

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

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/shopify_api/rest/resources/2022_04/payment.rb', line 104

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

.find(id:, checkout_id: nil, session: ShopifyAPI::Context.active_session) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/shopify_api/rest/resources/2022_04/payment.rb', line 63

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

Instance Method Details

#checkout_id ⇒ Object 



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

def checkout_id()
  @checkout&.token
end

#checkout_id=(val) ⇒ Object 



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

def checkout_id=(val)
  @checkout = @checkout || Checkout.new(session: @session)
  T.unsafe(@checkout).token = val
end