Class: ShopifyAPI::Event

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

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

Returns a new instance of Event.


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

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

  @arguments = T.let(nil, T.nilable(String))
  @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))
end

Dynamic Method Handling

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

Instance Attribute Details

#argumentsObject (readonly)

Returns the value of attribute arguments.


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

def arguments
  @arguments
end

#bodyObject (readonly)

Returns the value of attribute body.


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

def body
  @body
end

#created_atObject (readonly)

Returns the value of attribute created_at.


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

def created_at
  @created_at
end

#descriptionObject (readonly)

Returns the value of attribute description.


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

def description
  @description
end

#idObject (readonly)

Returns the value of attribute id.


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

def id
  @id
end

#messageObject (readonly)

Returns the value of attribute message.


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

def message
  @message
end

#pathObject (readonly)

Returns the value of attribute path.


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

def path
  @path
end

#subject_idObject (readonly)

Returns the value of attribute subject_id.


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

def subject_id
  @subject_id
end

#subject_typeObject (readonly)

Returns the value of attribute subject_type.


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

def subject_type
  @subject_type
end

#verbObject (readonly)

Returns the value of attribute verb.


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

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


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/shopify_api/rest/resources/2021_07/event.rb', line 94

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


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

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


66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/shopify_api/rest/resources/2021_07/event.rb', line 66

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