Class: ShopifyAPI::ApplicationCredit

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

Returns a new instance of ApplicationCredit.



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

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

  @amount = T.let(nil, T.nilable(String))
  @currency = T.let(nil, T.nilable(Currency))
  @description = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @test = T.let(nil, T.nilable(T::Boolean))

  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

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



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

def amount
  @amount
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



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

def currency
  @currency
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



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

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#test ⇒ Object (readonly)

Returns the value of attribute test.



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

def test
  @test
end

Class Method Details

.all(fields: 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/2022_04/application_credit.rb', line 79

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

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

.find(id:, fields: 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/2022_04/application_credit.rb', line 59

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(ApplicationCredit))
end