Class: ShopifyAPI::ApplicationCredit

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

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) ⇒ ApplicationCredit

Returns a new instance of ApplicationCredit.


12
13
14
15
16
17
18
19
# File 'lib/shopify_api/rest/resources/2021_07/application_credit.rb', line 12

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

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

Dynamic Method Handling

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

Instance Attribute Details

#amountObject (readonly)

Returns the value of attribute amount.


30
31
32
# File 'lib/shopify_api/rest/resources/2021_07/application_credit.rb', line 30

def amount
  @amount
end

#descriptionObject (readonly)

Returns the value of attribute description.


32
33
34
# File 'lib/shopify_api/rest/resources/2021_07/application_credit.rb', line 32

def description
  @description
end

#idObject (readonly)

Returns the value of attribute id.


34
35
36
# File 'lib/shopify_api/rest/resources/2021_07/application_credit.rb', line 34

def id
  @id
end

#testObject (readonly)

Returns the value of attribute test.


36
37
38
# File 'lib/shopify_api/rest/resources/2021_07/application_credit.rb', line 36

def test
  @test
end

Class Method Details

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


66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/shopify_api/rest/resources/2021_07/application_credit.rb', line 66

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


46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/shopify_api/rest/resources/2021_07/application_credit.rb', line 46

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