Class: ShopifyAPI::Report

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

Returns a new instance of Report.


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

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

  @category = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @name = T.let(nil, T.nilable(String))
  @shopify_ql = 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

#categoryObject (readonly)

Returns the value of attribute category.


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

def category
  @category
end

#idObject (readonly)

Returns the value of attribute id.


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

def id
  @id
end

#nameObject (readonly)

Returns the value of attribute name.


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

def name
  @name
end

#shopify_qlObject (readonly)

Returns the value of attribute shopify_ql.


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

def shopify_ql
  @shopify_ql
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


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

def updated_at
  @updated_at
end

Class Method Details

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


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

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

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

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


70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/shopify_api/rest/resources/2021_07/report.rb', line 70

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


51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/shopify_api/rest/resources/2021_07/report.rb', line 51

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