Class: ShopifyAPI::Payout

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

Returns a new instance of Payout.



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/shopify_api/rest/resources/2022_04/payout.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(String))
  @date = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @status = 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

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



38
39
40
 
# File 'lib/shopify_api/rest/resources/2022_04/payout.rb', line 38

def amount
  @amount
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



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

def currency
  @currency
end

#date ⇒ Object (readonly)

Returns the value of attribute date.



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

def date
  @date
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



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

def status
  @status
end

Class Method Details

.all(since_id: nil, last_id: nil, date_min: nil, date_max: nil, date: nil, status: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/shopify_api/rest/resources/2022_04/payout.rb', line 79

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

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

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



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/shopify_api/rest/resources/2022_04/payout.rb', line 55

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