Class: ShopifyAPI::UsageCharge

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


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

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

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

Returns the value of attribute created_at.


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

def created_at
  @created_at
end

#descriptionObject (readonly)

Returns the value of attribute description.


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

def description
  @description
end

#idObject (readonly)

Returns the value of attribute id.


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

def id
  @id
end

#priceObject (readonly)

Returns the value of attribute price.


38
39
40
# File 'lib/shopify_api/rest/resources/2021_07/usage_charge.rb', line 38

def price
  @price
end

#recurring_application_charge_idObject (readonly)

Returns the value of attribute recurring_application_charge_id.


40
41
42
# File 'lib/shopify_api/rest/resources/2021_07/usage_charge.rb', line 40

def recurring_application_charge_id
  @recurring_application_charge_id
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


42
43
44
# File 'lib/shopify_api/rest/resources/2021_07/usage_charge.rb', line 42

def updated_at
  @updated_at
end

Class Method Details

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


75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/shopify_api/rest/resources/2021_07/usage_charge.rb', line 75

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


53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/shopify_api/rest/resources/2021_07/usage_charge.rb', line 53

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