Class: ShopifyAPI::RecurringApplicationCharge

Inherits:
ShopifyAPI::Rest::Base show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb,
lib/shopify_api/rest/resources/2022_07/recurring_application_charge.rb,
lib/shopify_api/rest/resources/2022_10/recurring_application_charge.rb,
lib/shopify_api/rest/resources/2023_01/recurring_application_charge.rb,
lib/shopify_api/rest/resources/2023_04/recurring_application_charge.rb,
lib/shopify_api/rest/resources/2023_07/recurring_application_charge.rb,
lib/shopify_api/rest/resources/2023_10/recurring_application_charge.rb,
lib/shopify_api/rest/resources/2024_01/recurring_application_charge.rb,
lib/shopify_api/rest/resources/2024_04/recurring_application_charge.rb,
lib/shopify_api/rest/resources/2024_07/recurring_application_charge.rb,
lib/shopify_api/rest/resources/2024_10/recurring_application_charge.rb

Instance Attribute Summary collapse

Attributes inherited from ShopifyAPI::Rest::Base

#errors, #original_state

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ShopifyAPI::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) ⇒ RecurringApplicationCharge

Returns a new instance of RecurringApplicationCharge.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 19

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

  @activated_on = T.let(nil, T.nilable(String))
  @billing_on = T.let(nil, T.nilable(String))
  @cancelled_on = T.let(nil, T.nilable(String))
  @capped_amount = T.let(nil, T.nilable(T.any(String, Integer)))
  @confirmation_url = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @currency = T.let(nil, T.nilable(Currency))
  @id = T.let(nil, T.nilable(Integer))
  @name = T.let(nil, T.nilable(String))
  @price = T.let(nil, T.nilable(T.any(String, Float)))
  @return_url = T.let(nil, T.nilable(String))
  @status = T.let(nil, T.nilable(String))
  @terms = T.let(nil, T.nilable(String))
  @test = T.let(nil, T.nilable(T::Boolean))
  @trial_days = T.let(nil, T.nilable(Integer))
  @trial_ends_on = T.let(nil, T.nilable(String))
  @updated_at = 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

#activated_on ⇒ Object (readonly)

Returns the value of attribute activated_on.



55
56
57
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 55

def activated_on
  @activated_on
end

#billing_on ⇒ Object (readonly)

Returns the value of attribute billing_on.



57
58
59
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 57

def billing_on
  @billing_on
end

#cancelled_on ⇒ Object (readonly)

Returns the value of attribute cancelled_on.



59
60
61
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 59

def cancelled_on
  @cancelled_on
end

#capped_amount ⇒ Object (readonly)

Returns the value of attribute capped_amount.



61
62
63
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 61

def capped_amount
  @capped_amount
end

#confirmation_url ⇒ Object (readonly)

Returns the value of attribute confirmation_url.



63
64
65
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 63

def confirmation_url
  @confirmation_url
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



65
66
67
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 65

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



67
68
69
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 67

def currency
  @currency
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



69
70
71
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 69

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



71
72
73
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 71

def name
  @name
end

#price ⇒ Object (readonly)

Returns the value of attribute price.



73
74
75
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 73

def price
  @price
end

#return_url ⇒ Object (readonly)

Returns the value of attribute return_url.



75
76
77
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 75

def return_url
  @return_url
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



77
78
79
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 77

def status
  @status
end

#terms ⇒ Object (readonly)

Returns the value of attribute terms.



79
80
81
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 79

def terms
  @terms
end

#test ⇒ Object (readonly)

Returns the value of attribute test.



81
82
83
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 81

def test
  @test
end

#trial_days ⇒ Object (readonly)

Returns the value of attribute trial_days.



83
84
85
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 83

def trial_days
  @trial_days
end

#trial_ends_on ⇒ Object (readonly)

Returns the value of attribute trial_ends_on.



85
86
87
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 85

def trial_ends_on
  @trial_ends_on
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



87
88
89
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 87

def updated_at
  @updated_at
end

Class Method Details

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 137

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

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

.current(session: ShopifyAPI::Context.active_session) ⇒ Object 



156
157
158
159
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 156

def current(session: ShopifyAPI::Context.active_session)
  charges = all(session: session)
  charges.select { |charge| charge.status == "active" }.first
end

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



116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 116

def delete(
  id:,
  session: ShopifyAPI::Context.active_session
)
  request(
    http_method: :delete,
    operation: :delete,
    session: session,
    ids: {id: id},
    params: {},
  )
end

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



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 97

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

Instance Method Details

#customize(body: nil, **kwargs) ⇒ Object 



169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb', line 169

def customize(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :put,
    operation: :customize,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end