Class: ShopifyAPI::Payment
- Inherits:
-
Rest::Base
- Object
- Rest::Base
- ShopifyAPI::Payment
- Extended by:
- T::Sig
- Defined in:
- lib/shopify_api/rest/resources/2021_07/payment.rb,
lib/shopify_api/rest/resources/2021_10/payment.rb,
lib/shopify_api/rest/resources/2022_01/payment.rb,
lib/shopify_api/rest/resources/2022_04/payment.rb
Instance Attribute Summary collapse
-
#checkout ⇒ Object
readonly
Returns the value of attribute checkout.
-
#credit_card ⇒ Object
readonly
Returns the value of attribute credit_card.
-
#id ⇒ Object
readonly
Returns the value of attribute id.
-
#next_action ⇒ Object
readonly
Returns the value of attribute next_action.
-
#payment_processing_error_message ⇒ Object
readonly
Returns the value of attribute payment_processing_error_message.
-
#transaction ⇒ Object
readonly
Returns the value of attribute transaction.
-
#unique_token ⇒ Object
readonly
Returns the value of attribute unique_token.
Attributes inherited from Rest::Base
Class Method Summary collapse
- .all(checkout_id: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
- .count(checkout_id: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
- .find(id:, checkout_id: nil, session: ShopifyAPI::Context.active_session) ⇒ Object
Instance Method Summary collapse
- #checkout_id ⇒ Object
- #checkout_id=(val) ⇒ Object
-
#initialize(session: ShopifyAPI::Context.active_session) ⇒ Payment
constructor
A new instance of Payment.
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) ⇒ Payment
Returns a new instance of Payment.
12 13 14 15 16 17 18 19 20 21 22 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 12 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.
37 38 39 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 37 def checkout @checkout end |
#credit_card ⇒ Object (readonly)
Returns the value of attribute credit_card.
39 40 41 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 39 def credit_card @credit_card end |
#id ⇒ Object (readonly)
Returns the value of attribute id.
41 42 43 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 41 def id @id end |
#next_action ⇒ Object (readonly)
Returns the value of attribute next_action.
43 44 45 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 43 def next_action @next_action end |
#payment_processing_error_message ⇒ Object (readonly)
Returns the value of attribute payment_processing_error_message.
45 46 47 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 45 def @payment_processing_error_message end |
#transaction ⇒ Object (readonly)
Returns the value of attribute transaction.
47 48 49 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 47 def transaction @transaction end |
#unique_token ⇒ Object (readonly)
Returns the value of attribute unique_token.
49 50 51 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 49 def unique_token @unique_token end |
Class Method Details
.all(checkout_id: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 79 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
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 100 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
59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 59 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
121 122 123 |
# File 'lib/shopify_api/rest/resources/2021_07/payment.rb', line 121 def checkout_id() @checkout&.token end |