Class: ShopifyAPI::ApplicationCharge

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

Returns a new instance of ApplicationCharge.



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

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

  @confirmation_url = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @currency = T.let(nil, T.nilable(Currency))
  @id = T.let(nil, T.nilable(Integer))
  @name = T.let(nil, T.nilable(String))
  @price = T.let(nil, T.nilable(T.any(String, Float)))
  @return_url = T.let(nil, T.nilable(String))
  @status = T.let(nil, T.nilable(String))
  @test = T.let(nil, T.nilable(T::Boolean))
  @updated_at = 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

#confirmation_urlObject (readonly)

Returns the value of attribute confirmation_url.



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

def confirmation_url
  @confirmation_url
end

#created_atObject (readonly)

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#currencyObject (readonly)

Returns the value of attribute currency.



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

def currency
  @currency
end

#idObject (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#nameObject (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#priceObject (readonly)

Returns the value of attribute price.



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

def price
  @price
end

#return_urlObject (readonly)

Returns the value of attribute return_url.



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

def return_url
  @return_url
end

#statusObject (readonly)

Returns the value of attribute status.



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

def status
  @status
end

#testObject (readonly)

Returns the value of attribute test.



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

def test
  @test
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

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



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

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

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

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



70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/shopify_api/rest/resources/2022_04/application_charge.rb', line 70

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