Class: ShopifyAPI::Webhook
- Inherits:
-
Rest::Base
- Object
- Rest::Base
- ShopifyAPI::Webhook
- Extended by:
- T::Sig
- Defined in:
- lib/shopify_api/rest/resources/2022_04/webhook.rb,
lib/shopify_api/rest/resources/2022_07/webhook.rb,
lib/shopify_api/rest/resources/2022_10/webhook.rb,
lib/shopify_api/rest/resources/2023_01/webhook.rb,
lib/shopify_api/rest/resources/2023_04/webhook.rb,
lib/shopify_api/rest/resources/2023_07/webhook.rb
Instance Attribute Summary collapse
-
#address ⇒ Object
readonly
Returns the value of attribute address.
-
#api_version ⇒ Object
readonly
Returns the value of attribute api_version.
-
#created_at ⇒ Object
readonly
Returns the value of attribute created_at.
-
#fields ⇒ Object
readonly
Returns the value of attribute fields.
-
#format ⇒ Object
readonly
Returns the value of attribute format.
-
#id ⇒ Object
readonly
Returns the value of attribute id.
-
#metafield_namespaces ⇒ Object
readonly
Returns the value of attribute metafield_namespaces.
-
#private_metafield_namespaces ⇒ Object
readonly
Returns the value of attribute private_metafield_namespaces.
-
#topic ⇒ Object
readonly
Returns the value of attribute topic.
-
#updated_at ⇒ Object
readonly
Returns the value of attribute updated_at.
Attributes inherited from Rest::Base
Class Method Summary collapse
- .all(address: nil, created_at_max: nil, created_at_min: nil, fields: nil, limit: nil, since_id: nil, topic: nil, updated_at_min: nil, updated_at_max: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
- .count(address: nil, topic: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
- .delete(id:, session: ShopifyAPI::Context.active_session) ⇒ Object
- .find(id:, fields: nil, session: ShopifyAPI::Context.active_session) ⇒ Object
Instance Method Summary collapse
-
#initialize(session: ShopifyAPI::Context.active_session) ⇒ Webhook
constructor
A new instance of Webhook.
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, 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?, #save, #save!, #to_hash
Constructor Details
#initialize(session: ShopifyAPI::Context.active_session) ⇒ Webhook
Returns a new instance of Webhook.
16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 16 def initialize(session: ShopifyAPI::Context.active_session) super(session: session) @address = T.let(nil, T.nilable(String)) @topic = T.let(nil, T.nilable(String)) @api_version = T.let(nil, T.nilable(String)) @created_at = T.let(nil, T.nilable(String)) @fields = T.let(nil, T.nilable(T::Array[T.untyped])) @format = T.let(nil, T.nilable(String)) @id = T.let(nil, T.nilable(Integer)) @metafield_namespaces = T.let(nil, T.nilable(T::Array[T.untyped])) @private_metafield_namespaces = T.let(nil, T.nilable(T::Array[T.untyped])) @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
#address ⇒ Object (readonly)
Returns the value of attribute address.
43 44 45 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 43 def address @address end |
#api_version ⇒ Object (readonly)
Returns the value of attribute api_version.
47 48 49 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 47 def api_version @api_version end |
#created_at ⇒ Object (readonly)
Returns the value of attribute created_at.
49 50 51 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 49 def created_at @created_at end |
#fields ⇒ Object (readonly)
Returns the value of attribute fields.
51 52 53 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 51 def fields @fields end |
#format ⇒ Object (readonly)
Returns the value of attribute format.
53 54 55 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 53 def format @format end |
#id ⇒ Object (readonly)
Returns the value of attribute id.
55 56 57 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 55 def id @id end |
#metafield_namespaces ⇒ Object (readonly)
Returns the value of attribute metafield_namespaces.
57 58 59 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 57 def @metafield_namespaces end |
#private_metafield_namespaces ⇒ Object (readonly)
Returns the value of attribute private_metafield_namespaces.
59 60 61 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 59 def @private_metafield_namespaces end |
#topic ⇒ Object (readonly)
Returns the value of attribute topic.
45 46 47 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 45 def topic @topic end |
#updated_at ⇒ Object (readonly)
Returns the value of attribute updated_at.
61 62 63 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 61 def updated_at @updated_at end |
Class Method Details
.all(address: nil, created_at_max: nil, created_at_min: nil, fields: nil, limit: nil, since_id: nil, topic: nil, updated_at_min: nil, updated_at_max: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 118 def all( address: nil, created_at_max: nil, created_at_min: nil, fields: nil, limit: nil, since_id: nil, topic: nil, updated_at_min: nil, updated_at_max: nil, session: ShopifyAPI::Context.active_session, **kwargs ) response = base_find( session: session, ids: {}, params: {address: address, created_at_max: created_at_max, created_at_min: created_at_min, fields: fields, limit: limit, since_id: since_id, topic: topic, updated_at_min: updated_at_min, updated_at_max: updated_at_max}.merge(kwargs).compact, ) T.cast(response, T::Array[Webhook]) end |
.count(address: nil, topic: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 148 def count( address: nil, topic: nil, session: ShopifyAPI::Context.active_session, **kwargs ) request( http_method: :get, operation: :count, session: session, ids: {}, params: {address: address, topic: topic}.merge(kwargs).compact, body: {}, entity: nil, ) end |
.delete(id:, session: ShopifyAPI::Context.active_session) ⇒ Object
90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 90 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
71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/shopify_api/rest/resources/2022_04/webhook.rb', line 71 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(Webhook)) end |