Class: ShopifyAPI::Event

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

Returns a new instance of Event.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/shopify_api/rest/resources/2022_04/event.rb', line 19

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

  @arguments = T.let(nil, T.nilable(T::Array[T.untyped]))
  @body = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @description = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @message = T.let(nil, T.nilable(String))
  @path = T.let(nil, T.nilable(String))
  @subject_id = T.let(nil, T.nilable(Integer))
  @subject_type = T.let(nil, T.nilable(String))
  @verb = 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

#arguments ⇒ Object (readonly)

Returns the value of attribute arguments.



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

def arguments
  @arguments
end

#body ⇒ Object (readonly)

Returns the value of attribute body.



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

def body
  @body
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



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

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



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

def message
  @message
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



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

def path
  @path
end

#subject_id ⇒ Object (readonly)

Returns the value of attribute subject_id.



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

def subject_id
  @subject_id
end

#subject_type ⇒ Object (readonly)

Returns the value of attribute subject_type.



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

def subject_type
  @subject_type
end

#verb ⇒ Object (readonly)

Returns the value of attribute verb.



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

def verb
  @verb
end

Class Method Details

.all(order_id: nil, product_id: nil, limit: nil, since_id: nil, created_at_min: nil, created_at_max: nil, filter: nil, verb: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/shopify_api/rest/resources/2022_04/event.rb', line 102

def all(
  order_id: nil,
  product_id: nil,
  limit: nil,
  since_id: nil,
  created_at_min: nil,
  created_at_max: nil,
  filter: nil,
  verb: nil,
  fields: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {order_id: order_id, product_id: product_id},
    params: {limit: limit, since_id: since_id, created_at_min: created_at_min, created_at_max: created_at_max, filter: filter, verb: verb, fields: fields}.merge(kwargs).compact,
  )

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

.count(created_at_min: nil, created_at_max: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/shopify_api/rest/resources/2022_04/event.rb', line 132

def count(
  created_at_min: nil,
  created_at_max: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :count,
    session: session,
    ids: {},
    params: {created_at_min: created_at_min, created_at_max: created_at_max}.merge(kwargs).compact,
    body: {},
    entity: nil,
  )
end

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



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/shopify_api/rest/resources/2022_04/event.rb', line 74

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