Class: ShopifyAPI::RecurringApplicationCharge

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

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

Returns a new instance of RecurringApplicationCharge.


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 12

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

  @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))
  @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))
end

Dynamic Method Handling

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

Instance Attribute Details

#activated_onObject (readonly)

Returns the value of attribute activated_on.


44
45
46
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 44

def activated_on
  @activated_on
end

#billing_onObject (readonly)

Returns the value of attribute billing_on.


46
47
48
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 46

def billing_on
  @billing_on
end

#cancelled_onObject (readonly)

Returns the value of attribute cancelled_on.


48
49
50
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 48

def cancelled_on
  @cancelled_on
end

#capped_amountObject (readonly)

Returns the value of attribute capped_amount.


50
51
52
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 50

def capped_amount
  @capped_amount
end

#confirmation_urlObject (readonly)

Returns the value of attribute confirmation_url.


52
53
54
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 52

def confirmation_url
  @confirmation_url
end

#created_atObject (readonly)

Returns the value of attribute created_at.


54
55
56
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 54

def created_at
  @created_at
end

#idObject (readonly)

Returns the value of attribute id.


56
57
58
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 56

def id
  @id
end

#nameObject (readonly)

Returns the value of attribute name.


58
59
60
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 58

def name
  @name
end

#priceObject (readonly)

Returns the value of attribute price.


60
61
62
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 60

def price
  @price
end

#return_urlObject (readonly)

Returns the value of attribute return_url.


62
63
64
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 62

def return_url
  @return_url
end

#statusObject (readonly)

Returns the value of attribute status.


64
65
66
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 64

def status
  @status
end

#termsObject (readonly)

Returns the value of attribute terms.


66
67
68
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 66

def terms
  @terms
end

#testObject (readonly)

Returns the value of attribute test.


68
69
70
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 68

def test
  @test
end

#trial_daysObject (readonly)

Returns the value of attribute trial_days.


70
71
72
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 70

def trial_days
  @trial_days
end

#trial_ends_onObject (readonly)

Returns the value of attribute trial_ends_on.


72
73
74
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 72

def trial_ends_on
  @trial_ends_on
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


74
75
76
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 74

def updated_at
  @updated_at
end

Class Method Details

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


124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 124

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

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


103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 103

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


84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 84

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


147
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb', line 147

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