Class: ShopifyAPI::PaymentGateway

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

Returns a new instance of PaymentGateway.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 19

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

  @attachment = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @credential1 = T.let(nil, T.nilable(String))
  @credential2 = T.let(nil, T.nilable(String))
  @credential3 = T.let(nil, T.nilable(String))
  @credential4 = T.let(nil, T.nilable(String))
  @disabled = T.let(nil, T.nilable(T::Boolean))
  @enabled_card_brands = T.let(nil, T.nilable(T::Array[T.untyped]))
  @id = T.let(nil, T.nilable(Integer))
  @name = T.let(nil, T.nilable(String))
  @processing_method = T.let(nil, T.nilable(String))
  @provider_id = T.let(nil, T.nilable(Integer))
  @sandbox = T.let(nil, T.nilable(T::Boolean))
  @service_name = T.let(nil, T.nilable(String))
  @supports_network_tokenization = T.let(nil, T.nilable(T::Boolean))
  @type = T.let(nil, T.nilable(String))
  @updated_at = T.let(nil, T.nilable(String))

  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

#attachment ⇒ Object (readonly)

Returns the value of attribute attachment.



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

def attachment
  @attachment
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



55
56
57
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 55

def created_at
  @created_at
end

#credential1 ⇒ Object (readonly)

Returns the value of attribute credential1.



57
58
59
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 57

def credential1
  @credential1
end

#credential2 ⇒ Object (readonly)

Returns the value of attribute credential2.



59
60
61
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 59

def credential2
  @credential2
end

#credential3 ⇒ Object (readonly)

Returns the value of attribute credential3.



61
62
63
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 61

def credential3
  @credential3
end

#credential4 ⇒ Object (readonly)

Returns the value of attribute credential4.



63
64
65
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 63

def credential4
  @credential4
end

#disabled ⇒ Object (readonly)

Returns the value of attribute disabled.



65
66
67
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 65

def disabled
  @disabled
end

#enabled_card_brands ⇒ Object (readonly)

Returns the value of attribute enabled_card_brands.



67
68
69
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 67

def enabled_card_brands
  @enabled_card_brands
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



69
70
71
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 69

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



71
72
73
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 71

def name
  @name
end

#processing_method ⇒ Object (readonly)

Returns the value of attribute processing_method.



73
74
75
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 73

def processing_method
  @processing_method
end

#provider_id ⇒ Object (readonly)

Returns the value of attribute provider_id.



75
76
77
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 75

def provider_id
  @provider_id
end

#sandbox ⇒ Object (readonly)

Returns the value of attribute sandbox.



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

def sandbox
  @sandbox
end

#service_name ⇒ Object (readonly)

Returns the value of attribute service_name.



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

def service_name
  @service_name
end

#supports_network_tokenization ⇒ Object (readonly)

Returns the value of attribute supports_network_tokenization.



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

def supports_network_tokenization
  @supports_network_tokenization
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



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

def type
  @type
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

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



131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 131

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

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

.delete(id:, session: ShopifyAPI::Context.active_session) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 112

def delete(
  id:,
  session: ShopifyAPI::Context.active_session
)
  request(
    http_method: :delete,
    operation: :delete,
    session: session,
    ids: {id: id},
    params: {},
  )
end

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



94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/shopify_api/rest/resources/2022_04/payment_gateway.rb', line 94

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