Class: ShopifyAPI::Report

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

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

Returns a new instance of Report.



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/shopify_api/rest/resources/2022_04/report.rb', line 19

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

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

  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

#category ⇒ Object (readonly)

Returns the value of attribute category.



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

def category
  @category
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



43
44
45
 
# File 'lib/shopify_api/rest/resources/2022_04/report.rb', line 43

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#shopify_ql ⇒ Object (readonly)

Returns the value of attribute shopify_ql.



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

def shopify_ql
  @shopify_ql
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



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

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 



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

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 



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/shopify_api/rest/resources/2022_04/report.rb', line 78

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 



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/shopify_api/rest/resources/2022_04/report.rb', line 59

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