Class: ShopifyAPI::UsageCharge

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

Returns a new instance of UsageCharge.



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

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

  @created_at = 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))
  @price = T.let(nil, T.nilable(String))
  @recurring_application_charge_id = T.let(nil, T.nilable(Integer))
  @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

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



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

def currency
  @currency
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



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

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#price ⇒ Object (readonly)

Returns the value of attribute price.



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

def price
  @price
end

#recurring_application_charge_id ⇒ Object (readonly)

Returns the value of attribute recurring_application_charge_id.



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

def recurring_application_charge_id
  @recurring_application_charge_id
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/shopify_api/rest/resources/2022_04/usage_charge.rb', line 84

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

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

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



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/shopify_api/rest/resources/2022_04/usage_charge.rb', line 62

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