ghostcrawl 2.3.5 → 2.3.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +59 -12
  3. data/_generated/models/arrival_body.rb +325 -0
  4. data/_generated/models/arrival_body_profile_id_member1.rb +62 -0
  5. data/_generated/models/arrival_body_referrer_shape.rb +8 -0
  6. data/_generated/models/arrival_body_session_id_member1.rb +62 -0
  7. data/_generated/models/close_popups_body.rb +264 -0
  8. data/_generated/models/close_popups_body_keep_host_member1.rb +62 -0
  9. data/_generated/models/close_popups_body_profile_id_member1.rb +62 -0
  10. data/_generated/models/models.rb +18 -0
  11. data/_generated/models/mouse_body.rb +264 -0
  12. data/_generated/models/mouse_body_ops.rb +62 -0
  13. data/_generated/models/mouse_body_profile_id_member1.rb +62 -0
  14. data/_generated/models/mouse_body_session_id_member1.rb +62 -0
  15. data/_generated/models/scrape_request.rb +6 -6
  16. data/_generated/models/scrape_request_engine.rb +1 -1
  17. data/_generated/models/session_create_request.rb +3 -3
  18. data/_generated/models/tab_visit_body.rb +285 -0
  19. data/_generated/models/tab_visit_body_profile_id_member1.rb +62 -0
  20. data/_generated/models/tab_visit_body_session_id_member1.rb +62 -0
  21. data/_generated/models/touch_body.rb +264 -0
  22. data/_generated/models/touch_body_ops.rb +62 -0
  23. data/_generated/models/touch_body_profile_id_member1.rb +62 -0
  24. data/_generated/models/touch_body_session_id_member1.rb +62 -0
  25. data/_generated/v1/cdp/frame/frame_request_builder.rb +2 -2
  26. data/_generated/v1/crawl_runs/item/with_run_item_request_builder.rb +3 -3
  27. data/_generated/v1/page/arrival/arrival.rb +0 -0
  28. data/_generated/v1/page/arrival/arrival_request_builder.rb +74 -0
  29. data/_generated/v1/page/close_popups/close_popups.rb +0 -0
  30. data/_generated/v1/page/close_popups/close_popups_request_builder.rb +74 -0
  31. data/_generated/v1/page/mouse/mouse.rb +0 -0
  32. data/_generated/v1/page/mouse/mouse_request_builder.rb +74 -0
  33. data/_generated/v1/page/page_request_builder.rb +30 -0
  34. data/_generated/v1/page/tab_visit/tab_visit.rb +0 -0
  35. data/_generated/v1/page/tab_visit/tab_visit_request_builder.rb +74 -0
  36. data/_generated/v1/page/touch/touch.rb +0 -0
  37. data/_generated/v1/page/touch/touch_request_builder.rb +74 -0
  38. data/_generated/v1/profiles/item/with_name_item_request_builder.rb +2 -2
  39. data/_generated/v1/schedules/item/runs/runs_request_builder.rb +2 -2
  40. data/_generated/v1/search/jobs/item/with_job_item_request_builder.rb +2 -2
  41. data/_generated/v1/sessions/item/takeover/takeover_request_builder.rb +2 -2
  42. data/_generated/v1/sessions/sessions_request_builder.rb +3 -3
  43. data/lib/ghostcrawl/client.rb +1001 -46
  44. data/lib/ghostcrawl/error_codes.rb +26 -25
  45. data/lib/ghostcrawl/errors.rb +35 -2
  46. data/lib/ghostcrawl/version.rb +1 -1
  47. metadata +30 -2
@@ -0,0 +1,264 @@
1
+ require 'microsoft_kiota_abstractions'
2
+ require_relative '../ghostcrawl'
3
+ require_relative './models'
4
+
5
+ module GhostCrawl
6
+ module Models
7
+ class MouseBody
8
+ include MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
9
+ ##
10
+ # Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
11
+ @additional_data
12
+ ##
13
+ # The ops property
14
+ @ops
15
+ ##
16
+ # The profile_id property
17
+ @profile_id
18
+ ##
19
+ # The session_id property
20
+ @session_id
21
+ ##
22
+ ## Gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
23
+ ## @return a i_dictionary
24
+ ##
25
+ def additional_data
26
+ return @additional_data
27
+ end
28
+ ##
29
+ ## Sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
30
+ ## @param value Value to set for the AdditionalData property.
31
+ ## @return a void
32
+ ##
33
+ def additional_data=(value)
34
+ @additional_data = value
35
+ end
36
+ ##
37
+ ## Instantiates a new MouseBody and sets the default values.
38
+ ## @return a void
39
+ ##
40
+ def initialize()
41
+ @additional_data = Hash.new
42
+ end
43
+ ##
44
+ ## Creates a new instance of the appropriate class based on discriminator value
45
+ ## @param parse_node The parse node to use to read the discriminator value and create the object
46
+ ## @return a mouse_body
47
+ ##
48
+ def self.create_from_discriminator_value(parse_node)
49
+ raise StandardError, 'parse_node cannot be null' if parse_node.nil?
50
+ return MouseBody.new
51
+ end
52
+ ##
53
+ ## The deserialization information for the current model
54
+ ## @return a i_dictionary
55
+ ##
56
+ def get_field_deserializers()
57
+ return {
58
+ "ops" => lambda {|n| @ops = n.get_collection_of_object_values(lambda {|pn| GhostCrawl::Models::MouseBodyOps.create_from_discriminator_value(pn) }) },
59
+ "profile_id" => lambda {|n| @profile_id = n.get_object_value(lambda {|pn| MouseBody::MouseBodyProfileId.create_from_discriminator_value(pn) }) },
60
+ "session_id" => lambda {|n| @session_id = n.get_object_value(lambda {|pn| MouseBody::MouseBodySessionId.create_from_discriminator_value(pn) }) },
61
+ }
62
+ end
63
+ ##
64
+ ## Gets the ops property value. The ops property
65
+ ## @return a mouse_body_ops
66
+ ##
67
+ def ops
68
+ return @ops
69
+ end
70
+ ##
71
+ ## Sets the ops property value. The ops property
72
+ ## @param value Value to set for the ops property.
73
+ ## @return a void
74
+ ##
75
+ def ops=(value)
76
+ @ops = value
77
+ end
78
+ ##
79
+ ## Gets the profile_id property value. The profile_id property
80
+ ## @return a mouse_body_profile_id
81
+ ##
82
+ def profile_id
83
+ return @profile_id
84
+ end
85
+ ##
86
+ ## Sets the profile_id property value. The profile_id property
87
+ ## @param value Value to set for the profile_id property.
88
+ ## @return a void
89
+ ##
90
+ def profile_id=(value)
91
+ @profile_id = value
92
+ end
93
+ ##
94
+ ## Serializes information the current object
95
+ ## @param writer Serialization writer to use to serialize this model
96
+ ## @return a void
97
+ ##
98
+ def serialize(writer)
99
+ raise StandardError, 'writer cannot be null' if writer.nil?
100
+ writer.write_collection_of_object_values("ops", @ops)
101
+ writer.write_object_value("profile_id", @profile_id)
102
+ writer.write_object_value("session_id", @session_id)
103
+ writer.write_additional_data(@additional_data)
104
+ end
105
+ ##
106
+ ## Gets the session_id property value. The session_id property
107
+ ## @return a mouse_body_session_id
108
+ ##
109
+ def session_id
110
+ return @session_id
111
+ end
112
+ ##
113
+ ## Sets the session_id property value. The session_id property
114
+ ## @param value Value to set for the session_id property.
115
+ ## @return a void
116
+ ##
117
+ def session_id=(value)
118
+ @session_id = value
119
+ end
120
+
121
+ ##
122
+ # Composed type wrapper for classes MouseBodyProfileIdMember1, string
123
+ class MouseBodyProfileId
124
+ include MicrosoftKiotaAbstractions::Parsable
125
+ ##
126
+ # Composed type representation for type MouseBodyProfileIdMember1
127
+ @mouse_body_profile_id_member1
128
+ ##
129
+ # Composed type representation for type string
130
+ @string
131
+ ##
132
+ ## Creates a new instance of the appropriate class based on discriminator value
133
+ ## @param parse_node The parse node to use to read the discriminator value and create the object
134
+ ## @return a mouse_body_profile_id
135
+ ##
136
+ def self.create_from_discriminator_value(parse_node)
137
+ raise StandardError, 'parse_node cannot be null' if parse_node.nil?
138
+ return MouseBodyProfileId.new
139
+ end
140
+ ##
141
+ ## The deserialization information for the current model
142
+ ## @return a i_dictionary
143
+ ##
144
+ def get_field_deserializers()
145
+ return {
146
+ "MouseBody_profile_idMember1" => lambda {|n| @mouse_body_profile_id_member1 = n.get_object_value(lambda {|pn| GhostCrawl::Models::MouseBodyProfileIdMember1.create_from_discriminator_value(pn) }) },
147
+ "string" => lambda {|n| @string = n.get_string_value() },
148
+ }
149
+ end
150
+ ##
151
+ ## Gets the MouseBody_profile_idMember1 property value. Composed type representation for type MouseBodyProfileIdMember1
152
+ ## @return a mouse_body_profile_id_member1
153
+ ##
154
+ def mouse_body_profile_id_member1
155
+ return @mouse_body_profile_id_member1
156
+ end
157
+ ##
158
+ ## Sets the MouseBody_profile_idMember1 property value. Composed type representation for type MouseBodyProfileIdMember1
159
+ ## @param value Value to set for the MouseBody_profile_idMember1 property.
160
+ ## @return a void
161
+ ##
162
+ def mouse_body_profile_id_member1=(value)
163
+ @mouse_body_profile_id_member1 = value
164
+ end
165
+ ##
166
+ ## Serializes information the current object
167
+ ## @param writer Serialization writer to use to serialize this model
168
+ ## @return a void
169
+ ##
170
+ def serialize(writer)
171
+ raise StandardError, 'writer cannot be null' if writer.nil?
172
+ writer.write_object_value("MouseBody_profile_idMember1", @mouse_body_profile_id_member1)
173
+ writer.write_string_value("string", @string)
174
+ end
175
+ ##
176
+ ## Gets the string property value. Composed type representation for type string
177
+ ## @return a string
178
+ ##
179
+ def string
180
+ return @string
181
+ end
182
+ ##
183
+ ## Sets the string property value. Composed type representation for type string
184
+ ## @param value Value to set for the string property.
185
+ ## @return a void
186
+ ##
187
+ def string=(value)
188
+ @string = value
189
+ end
190
+ end
191
+
192
+ ##
193
+ # Composed type wrapper for classes MouseBodySessionIdMember1, string
194
+ class MouseBodySessionId
195
+ include MicrosoftKiotaAbstractions::Parsable
196
+ ##
197
+ # Composed type representation for type MouseBodySessionIdMember1
198
+ @mouse_body_session_id_member1
199
+ ##
200
+ # Composed type representation for type string
201
+ @string
202
+ ##
203
+ ## Creates a new instance of the appropriate class based on discriminator value
204
+ ## @param parse_node The parse node to use to read the discriminator value and create the object
205
+ ## @return a mouse_body_session_id
206
+ ##
207
+ def self.create_from_discriminator_value(parse_node)
208
+ raise StandardError, 'parse_node cannot be null' if parse_node.nil?
209
+ return MouseBodySessionId.new
210
+ end
211
+ ##
212
+ ## The deserialization information for the current model
213
+ ## @return a i_dictionary
214
+ ##
215
+ def get_field_deserializers()
216
+ return {
217
+ "MouseBody_session_idMember1" => lambda {|n| @mouse_body_session_id_member1 = n.get_object_value(lambda {|pn| GhostCrawl::Models::MouseBodySessionIdMember1.create_from_discriminator_value(pn) }) },
218
+ "string" => lambda {|n| @string = n.get_string_value() },
219
+ }
220
+ end
221
+ ##
222
+ ## Gets the MouseBody_session_idMember1 property value. Composed type representation for type MouseBodySessionIdMember1
223
+ ## @return a mouse_body_session_id_member1
224
+ ##
225
+ def mouse_body_session_id_member1
226
+ return @mouse_body_session_id_member1
227
+ end
228
+ ##
229
+ ## Sets the MouseBody_session_idMember1 property value. Composed type representation for type MouseBodySessionIdMember1
230
+ ## @param value Value to set for the MouseBody_session_idMember1 property.
231
+ ## @return a void
232
+ ##
233
+ def mouse_body_session_id_member1=(value)
234
+ @mouse_body_session_id_member1 = value
235
+ end
236
+ ##
237
+ ## Serializes information the current object
238
+ ## @param writer Serialization writer to use to serialize this model
239
+ ## @return a void
240
+ ##
241
+ def serialize(writer)
242
+ raise StandardError, 'writer cannot be null' if writer.nil?
243
+ writer.write_object_value("MouseBody_session_idMember1", @mouse_body_session_id_member1)
244
+ writer.write_string_value("string", @string)
245
+ end
246
+ ##
247
+ ## Gets the string property value. Composed type representation for type string
248
+ ## @return a string
249
+ ##
250
+ def string
251
+ return @string
252
+ end
253
+ ##
254
+ ## Sets the string property value. Composed type representation for type string
255
+ ## @param value Value to set for the string property.
256
+ ## @return a void
257
+ ##
258
+ def string=(value)
259
+ @string = value
260
+ end
261
+ end
262
+ end
263
+ end
264
+ end
@@ -0,0 +1,62 @@
1
+ require 'microsoft_kiota_abstractions'
2
+ require_relative '../ghostcrawl'
3
+ require_relative './models'
4
+
5
+ module GhostCrawl
6
+ module Models
7
+ class MouseBodyOps
8
+ include MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
9
+ ##
10
+ # Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
11
+ @additional_data
12
+ ##
13
+ ## Gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
14
+ ## @return a i_dictionary
15
+ ##
16
+ def additional_data
17
+ return @additional_data
18
+ end
19
+ ##
20
+ ## Sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
21
+ ## @param value Value to set for the AdditionalData property.
22
+ ## @return a void
23
+ ##
24
+ def additional_data=(value)
25
+ @additional_data = value
26
+ end
27
+ ##
28
+ ## Instantiates a new MouseBodyOps and sets the default values.
29
+ ## @return a void
30
+ ##
31
+ def initialize()
32
+ @additional_data = Hash.new
33
+ end
34
+ ##
35
+ ## Creates a new instance of the appropriate class based on discriminator value
36
+ ## @param parse_node The parse node to use to read the discriminator value and create the object
37
+ ## @return a mouse_body_ops
38
+ ##
39
+ def self.create_from_discriminator_value(parse_node)
40
+ raise StandardError, 'parse_node cannot be null' if parse_node.nil?
41
+ return MouseBodyOps.new
42
+ end
43
+ ##
44
+ ## The deserialization information for the current model
45
+ ## @return a i_dictionary
46
+ ##
47
+ def get_field_deserializers()
48
+ return {
49
+ }
50
+ end
51
+ ##
52
+ ## Serializes information the current object
53
+ ## @param writer Serialization writer to use to serialize this model
54
+ ## @return a void
55
+ ##
56
+ def serialize(writer)
57
+ raise StandardError, 'writer cannot be null' if writer.nil?
58
+ writer.write_additional_data(@additional_data)
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,62 @@
1
+ require 'microsoft_kiota_abstractions'
2
+ require_relative '../ghostcrawl'
3
+ require_relative './models'
4
+
5
+ module GhostCrawl
6
+ module Models
7
+ class MouseBodyProfileIdMember1
8
+ include MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
9
+ ##
10
+ # Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
11
+ @additional_data
12
+ ##
13
+ ## Gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
14
+ ## @return a i_dictionary
15
+ ##
16
+ def additional_data
17
+ return @additional_data
18
+ end
19
+ ##
20
+ ## Sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
21
+ ## @param value Value to set for the AdditionalData property.
22
+ ## @return a void
23
+ ##
24
+ def additional_data=(value)
25
+ @additional_data = value
26
+ end
27
+ ##
28
+ ## Instantiates a new MouseBodyProfileIdMember1 and sets the default values.
29
+ ## @return a void
30
+ ##
31
+ def initialize()
32
+ @additional_data = Hash.new
33
+ end
34
+ ##
35
+ ## Creates a new instance of the appropriate class based on discriminator value
36
+ ## @param parse_node The parse node to use to read the discriminator value and create the object
37
+ ## @return a mouse_body_profile_id_member1
38
+ ##
39
+ def self.create_from_discriminator_value(parse_node)
40
+ raise StandardError, 'parse_node cannot be null' if parse_node.nil?
41
+ return MouseBodyProfileIdMember1.new
42
+ end
43
+ ##
44
+ ## The deserialization information for the current model
45
+ ## @return a i_dictionary
46
+ ##
47
+ def get_field_deserializers()
48
+ return {
49
+ }
50
+ end
51
+ ##
52
+ ## Serializes information the current object
53
+ ## @param writer Serialization writer to use to serialize this model
54
+ ## @return a void
55
+ ##
56
+ def serialize(writer)
57
+ raise StandardError, 'writer cannot be null' if writer.nil?
58
+ writer.write_additional_data(@additional_data)
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,62 @@
1
+ require 'microsoft_kiota_abstractions'
2
+ require_relative '../ghostcrawl'
3
+ require_relative './models'
4
+
5
+ module GhostCrawl
6
+ module Models
7
+ class MouseBodySessionIdMember1
8
+ include MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
9
+ ##
10
+ # Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
11
+ @additional_data
12
+ ##
13
+ ## Gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
14
+ ## @return a i_dictionary
15
+ ##
16
+ def additional_data
17
+ return @additional_data
18
+ end
19
+ ##
20
+ ## Sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
21
+ ## @param value Value to set for the AdditionalData property.
22
+ ## @return a void
23
+ ##
24
+ def additional_data=(value)
25
+ @additional_data = value
26
+ end
27
+ ##
28
+ ## Instantiates a new MouseBodySessionIdMember1 and sets the default values.
29
+ ## @return a void
30
+ ##
31
+ def initialize()
32
+ @additional_data = Hash.new
33
+ end
34
+ ##
35
+ ## Creates a new instance of the appropriate class based on discriminator value
36
+ ## @param parse_node The parse node to use to read the discriminator value and create the object
37
+ ## @return a mouse_body_session_id_member1
38
+ ##
39
+ def self.create_from_discriminator_value(parse_node)
40
+ raise StandardError, 'parse_node cannot be null' if parse_node.nil?
41
+ return MouseBodySessionIdMember1.new
42
+ end
43
+ ##
44
+ ## The deserialization information for the current model
45
+ ## @return a i_dictionary
46
+ ##
47
+ def get_field_deserializers()
48
+ return {
49
+ }
50
+ end
51
+ ##
52
+ ## Serializes information the current object
53
+ ## @param writer Serialization writer to use to serialize this model
54
+ ## @return a void
55
+ ##
56
+ def serialize(writer)
57
+ raise StandardError, 'writer cannot be null' if writer.nil?
58
+ writer.write_additional_data(@additional_data)
59
+ end
60
+ end
61
+ end
62
+ end
@@ -21,7 +21,7 @@ module GhostCrawl
21
21
  # Maximum tokens per markdown chunk. Clamped server-side to [256, 32768] regardless of caller input.
22
22
  @chunk_tokens
23
23
  ##
24
- # Engine override. 'auto' (default): the identity's fingerprint decides the engine. 'chrome'|'firefox'|'webkit': force that engine, enforced only if coherent with the identity (e.g. iOS identities are always webkit); incoherent picks are rejected, never coerced to a hybrid.
24
+ # Engine override. 'auto' (default): the identity's browser decides the engine. 'chrome'|'firefox'|'webkit': force that engine, enforced only if coherent with the identity (e.g. iOS identities are always webkit); incoherent picks are rejected, never coerced to a hybrid.
25
25
  @engine
26
26
  ##
27
27
  # Response format. 'html' (default): the fully rendered DOM. 'markdown': returns a {markdown, chunks, citations, token_estimate} envelope with prompt-injection-neutralized, token-budgeted output. 'pdf': returns application/pdf bytes (Chrome identities only; Firefox and WebKit return 400 pdf_engine_unsupported).
@@ -42,7 +42,7 @@ module GhostCrawl
42
42
  # Optional browser language tag (e.g. 'en-US','es-ES','de-DE'). Sets the identity's locale and language headers coherently, independent of the exit country. When omitted, the identity's default locale is used. Available on every tier.
43
43
  @language
44
44
  ##
45
- # Named persistent profile (multi-accounting). Resolves to a durable identity_id (→ same deterministic fingerprint) + optional saved storage_state (→ cookies/localStorage) for the calling org. Reuses the exact identity+cookies on every request, with no 30-minute sticky-session expiry. 404 if the named profile does not exist for the org.
45
+ # Named persistent profile (multi-accounting). Resolves to a durable identity_id (→ the same browser identity every time) + optional saved storage_state (→ cookies/localStorage) for the calling org. Reuses the exact identity+cookies on every request, with no 30-minute sticky-session expiry. 404 if the named profile does not exist for the org.
46
46
  @profile
47
47
  ##
48
48
  # Bring-your-own proxy URL. Schemes: socks5, socks5h, http, https. Any credentials in the URL are redacted from logs. Example: socks5://user:pass@host:1080.
@@ -157,14 +157,14 @@ module GhostCrawl
157
157
  return ScrapeRequest.new
158
158
  end
159
159
  ##
160
- ## Gets the engine property value. Engine override. 'auto' (default): the identity's fingerprint decides the engine. 'chrome'|'firefox'|'webkit': force that engine, enforced only if coherent with the identity (e.g. iOS identities are always webkit); incoherent picks are rejected, never coerced to a hybrid.
160
+ ## Gets the engine property value. Engine override. 'auto' (default): the identity's browser decides the engine. 'chrome'|'firefox'|'webkit': force that engine, enforced only if coherent with the identity (e.g. iOS identities are always webkit); incoherent picks are rejected, never coerced to a hybrid.
161
161
  ## @return a scrape_request_engine
162
162
  ##
163
163
  def engine
164
164
  return @engine
165
165
  end
166
166
  ##
167
- ## Sets the engine property value. Engine override. 'auto' (default): the identity's fingerprint decides the engine. 'chrome'|'firefox'|'webkit': force that engine, enforced only if coherent with the identity (e.g. iOS identities are always webkit); incoherent picks are rejected, never coerced to a hybrid.
167
+ ## Sets the engine property value. Engine override. 'auto' (default): the identity's browser decides the engine. 'chrome'|'firefox'|'webkit': force that engine, enforced only if coherent with the identity (e.g. iOS identities are always webkit); incoherent picks are rejected, never coerced to a hybrid.
168
168
  ## @param value Value to set for the engine property.
169
169
  ## @return a void
170
170
  ##
@@ -290,14 +290,14 @@ module GhostCrawl
290
290
  @language = value
291
291
  end
292
292
  ##
293
- ## Gets the profile property value. Named persistent profile (multi-accounting). Resolves to a durable identity_id (→ same deterministic fingerprint) + optional saved storage_state (→ cookies/localStorage) for the calling org. Reuses the exact identity+cookies on every request, with no 30-minute sticky-session expiry. 404 if the named profile does not exist for the org.
293
+ ## Gets the profile property value. Named persistent profile (multi-accounting). Resolves to a durable identity_id (→ the same browser identity every time) + optional saved storage_state (→ cookies/localStorage) for the calling org. Reuses the exact identity+cookies on every request, with no 30-minute sticky-session expiry. 404 if the named profile does not exist for the org.
294
294
  ## @return a scrape_request_profile
295
295
  ##
296
296
  def profile
297
297
  return @profile
298
298
  end
299
299
  ##
300
- ## Sets the profile property value. Named persistent profile (multi-accounting). Resolves to a durable identity_id (→ same deterministic fingerprint) + optional saved storage_state (→ cookies/localStorage) for the calling org. Reuses the exact identity+cookies on every request, with no 30-minute sticky-session expiry. 404 if the named profile does not exist for the org.
300
+ ## Sets the profile property value. Named persistent profile (multi-accounting). Resolves to a durable identity_id (→ the same browser identity every time) + optional saved storage_state (→ cookies/localStorage) for the calling org. Reuses the exact identity+cookies on every request, with no 30-minute sticky-session expiry. 404 if the named profile does not exist for the org.
301
301
  ## @param value Value to set for the profile property.
302
302
  ## @return a void
303
303
  ##
@@ -1,7 +1,7 @@
1
1
  module GhostCrawl
2
2
  module Models
3
3
  ##
4
- # Engine override. 'auto' (default): the identity's fingerprint decides the engine. 'chrome'|'firefox'|'webkit': force that engine, enforced only if coherent with the identity (e.g. iOS identities are always webkit); incoherent picks are rejected, never coerced to a hybrid.
4
+ # Engine override. 'auto' (default): the identity's browser decides the engine. 'chrome'|'firefox'|'webkit': force that engine, enforced only if coherent with the identity (e.g. iOS identities are always webkit); incoherent picks are rejected, never coerced to a hybrid.
5
5
  ScrapeRequestEngine = {
6
6
  Auto: :Auto,
7
7
  Chrome: :Chrome,
@@ -13,7 +13,7 @@ module GhostCrawl
13
13
  # The engine property
14
14
  @engine
15
15
  ##
16
- # Rehydrates the saved identity bundle for this session, same deterministic fingerprint as /v1/scrape with profile=<name>.
16
+ # Named persistent profile. Rehydrates the saved identity bundle for this session, the same browser identity as /v1/scrape with profile=<name>.
17
17
  @profile
18
18
  ##
19
19
  ## Gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
@@ -73,14 +73,14 @@ module GhostCrawl
73
73
  }
74
74
  end
75
75
  ##
76
- ## Gets the profile property value. Rehydrates the saved identity bundle for this session, same deterministic fingerprint as /v1/scrape with profile=<name>.
76
+ ## Gets the profile property value. Named persistent profile. Rehydrates the saved identity bundle for this session, the same browser identity as /v1/scrape with profile=<name>.
77
77
  ## @return a session_create_request_profile
78
78
  ##
79
79
  def profile
80
80
  return @profile
81
81
  end
82
82
  ##
83
- ## Sets the profile property value. Rehydrates the saved identity bundle for this session, same deterministic fingerprint as /v1/scrape with profile=<name>.
83
+ ## Sets the profile property value. Named persistent profile. Rehydrates the saved identity bundle for this session, the same browser identity as /v1/scrape with profile=<name>.
84
84
  ## @param value Value to set for the profile property.
85
85
  ## @return a void
86
86
  ##