safetykit 0.8.0 → 0.10.0

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ea98dd4027773e79eff1dc5b63dc59680abc966697571bc4840a232d997f873a
4
- data.tar.gz: 90b79a1ff7df6e669b1c88967f78e131eeb60d496aac6d130e527e5598ab8baa
3
+ metadata.gz: 18d4c898a7bdefdec9b263795c9926227f77232a5f2da50f728f5bd50c308220
4
+ data.tar.gz: e47f52616b601c40e3402979a2d5f79d3782e5d8aad4027d3521ea9f66399f3c
5
5
  SHA512:
6
- metadata.gz: 2f2731fcf22c4cabb4f238c8f0dd5e80c911fe89567cf8252bbcc79dd49fb495952fc1e4d04b78200fee284ad2af955e44486b237ad56b047077f494a1290eae
7
- data.tar.gz: 48e1a95d8b51a83e014a4dcac9798c3418baf6643203318b037efb7789fc832336ee8a09a1504e1cedbbf5ba4fa2d2a9c2ad52f385625667664ded520594c386
6
+ metadata.gz: 1d2a4c106c7fe8376a58d466cab735769e94110b3cf4360be8b789820a336e007456e6c5ae444bc07512784b6168980cc964f261c7fcbbcf5de2df38c76ac703
7
+ data.tar.gz: 8dc9ec8ced457812412944b1504acd16e7232ff530df96eccdb72ec11fbf85faf16b9f8a21629f7f8aa33bc66e2ee4e94fc27bca098a1d4b642dc0b74c87435c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.10.0 (2026-06-01)
4
+
5
+ Full Changelog: [v0.9.0...v0.10.0](https://github.com/GetSafetyKit/safetykit-ruby/compare/v0.9.0...v0.10.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([aee3f63](https://github.com/GetSafetyKit/safetykit-ruby/commit/aee3f6328ed102537734db57da1b09fc90c8b5a7))
10
+
11
+ ## 0.9.0 (2026-06-01)
12
+
13
+ Full Changelog: [v0.8.0...v0.9.0](https://github.com/GetSafetyKit/safetykit-ruby/compare/v0.8.0...v0.9.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([b7fe7a1](https://github.com/GetSafetyKit/safetykit-ruby/commit/b7fe7a10ba9629daa9877731d322d59c8b192e9a))
18
+
3
19
  ## 0.8.0 (2026-06-01)
4
20
 
5
21
  Full Changelog: [v0.7.0...v0.8.0](https://github.com/GetSafetyKit/safetykit-ruby/compare/v0.7.0...v0.8.0)
data/README.md CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
17
17
  <!-- x-release-please-start-version -->
18
18
 
19
19
  ```ruby
20
- gem "safetykit", "~> 0.8.0"
20
+ gem "safetykit", "~> 0.10.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -653,14 +653,6 @@ module SafetyKit
653
653
  optional :metadata,
654
654
  -> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Metadata] }
655
655
 
656
- # @!attribute properties
657
- # Stable, typed account-level facts SafetyKit can use in rules and aggregate
658
- # analysis.
659
- #
660
- # @return [SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Properties, nil]
661
- optional :properties,
662
- -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Properties }
663
-
664
656
  # @!attribute resources_used
665
657
  # Reusable resources observed during the event. Use this for emails, phone
666
658
  # numbers, names, addresses, social handles, URLs, payment identifiers, or similar
@@ -670,7 +662,7 @@ module SafetyKit
670
662
  optional :resources_used,
671
663
  -> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed] }
672
664
 
673
- # @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, metadata: nil, properties: nil, resources_used: nil)
665
+ # @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, metadata: nil, resources_used: nil)
674
666
  # Some parameter documentations has been truncated, see
675
667
  # {SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest}
676
668
  # for more details.
@@ -689,8 +681,6 @@ module SafetyKit
689
681
  #
690
682
  # @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
691
683
  #
692
- # @param properties [SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Properties] Stable, typed account-level facts SafetyKit can use in rules and aggregate analy
693
- #
694
684
  # @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
695
685
 
696
686
  # @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest#type
@@ -871,45 +861,6 @@ module SafetyKit
871
861
  }]
872
862
  end
873
863
 
874
- # @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest#properties
875
- class Properties < SafetyKit::Internal::Type::BaseModel
876
- # @!attribute account_state
877
- # Current account lifecycle or moderation state.
878
- #
879
- # @return [String, nil]
880
- optional :account_state, String
881
-
882
- # @!attribute account_types
883
- # Stable account categories in your product.
884
- #
885
- # @return [Array<String>, nil]
886
- optional :account_types, SafetyKit::Internal::Type::ArrayOf[String]
887
-
888
- # @!attribute country
889
- # Country associated with the account.
890
- #
891
- # @return [String, nil]
892
- optional :country, String
893
-
894
- # @!attribute email_verified
895
- # Whether the account's email address has been verified.
896
- #
897
- # @return [Boolean, nil]
898
- optional :email_verified, SafetyKit::Internal::Type::Boolean
899
-
900
- # @!method initialize(account_state: nil, account_types: nil, country: nil, email_verified: nil)
901
- # Stable, typed account-level facts SafetyKit can use in rules and aggregate
902
- # analysis.
903
- #
904
- # @param account_state [String] Current account lifecycle or moderation state.
905
- #
906
- # @param account_types [Array<String>] Stable account categories in your product.
907
- #
908
- # @param country [String] Country associated with the account.
909
- #
910
- # @param email_verified [Boolean] Whether the account's email address has been verified.
911
- end
912
-
913
864
  class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
914
865
  # @!attribute type
915
866
  # Resource family, such as email, phone, name, address, url, instagram, tiktok,
@@ -981,14 +932,6 @@ module SafetyKit
981
932
  optional :metadata,
982
933
  -> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Metadata] }
983
934
 
984
- # @!attribute properties
985
- # Stable, typed account-level facts SafetyKit can use in rules and aggregate
986
- # analysis.
987
- #
988
- # @return [SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Properties, nil]
989
- optional :properties,
990
- -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Properties }
991
-
992
935
  # @!attribute resources_used
993
936
  # Reusable resources observed during the event. Use this for emails, phone
994
937
  # numbers, names, addresses, social handles, URLs, payment identifiers, or similar
@@ -998,7 +941,7 @@ module SafetyKit
998
941
  optional :resources_used,
999
942
  -> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed] }
1000
943
 
1001
- # @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, metadata: nil, properties: nil, resources_used: nil)
944
+ # @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, metadata: nil, resources_used: nil)
1002
945
  # Some parameter documentations has been truncated, see
1003
946
  # {SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest}
1004
947
  # for more details.
@@ -1018,8 +961,6 @@ module SafetyKit
1018
961
  #
1019
962
  # @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
1020
963
  #
1021
- # @param properties [SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Properties] Stable, typed account-level facts SafetyKit can use in rules and aggregate analy
1022
- #
1023
964
  # @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
1024
965
 
1025
966
  # @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest#type
@@ -1200,45 +1141,6 @@ module SafetyKit
1200
1141
  }]
1201
1142
  end
1202
1143
 
1203
- # @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest#properties
1204
- class Properties < SafetyKit::Internal::Type::BaseModel
1205
- # @!attribute account_state
1206
- # Current account lifecycle or moderation state.
1207
- #
1208
- # @return [String, nil]
1209
- optional :account_state, String
1210
-
1211
- # @!attribute account_types
1212
- # Stable account categories in your product.
1213
- #
1214
- # @return [Array<String>, nil]
1215
- optional :account_types, SafetyKit::Internal::Type::ArrayOf[String]
1216
-
1217
- # @!attribute country
1218
- # Country associated with the account.
1219
- #
1220
- # @return [String, nil]
1221
- optional :country, String
1222
-
1223
- # @!attribute email_verified
1224
- # Whether the account's email address has been verified.
1225
- #
1226
- # @return [Boolean, nil]
1227
- optional :email_verified, SafetyKit::Internal::Type::Boolean
1228
-
1229
- # @!method initialize(account_state: nil, account_types: nil, country: nil, email_verified: nil)
1230
- # Stable, typed account-level facts SafetyKit can use in rules and aggregate
1231
- # analysis.
1232
- #
1233
- # @param account_state [String] Current account lifecycle or moderation state.
1234
- #
1235
- # @param account_types [Array<String>] Stable account categories in your product.
1236
- #
1237
- # @param country [String] Country associated with the account.
1238
- #
1239
- # @param email_verified [Boolean] Whether the account's email address has been verified.
1240
- end
1241
-
1242
1144
  class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
1243
1145
  # @!attribute type
1244
1146
  # Resource family, such as email, phone, name, address, url, instagram, tiktok,
@@ -1875,14 +1777,6 @@ module SafetyKit
1875
1777
  optional :metadata,
1876
1778
  -> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Metadata] }
1877
1779
 
1878
- # @!attribute properties
1879
- # Stable, typed account-level facts SafetyKit can use in rules and aggregate
1880
- # analysis.
1881
- #
1882
- # @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Properties, nil]
1883
- optional :properties,
1884
- -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Properties }
1885
-
1886
1780
  # @!attribute resources_used
1887
1781
  # Reusable resources observed during the event. Use this for emails, phone
1888
1782
  # numbers, names, addresses, social handles, URLs, payment identifiers, or similar
@@ -1892,7 +1786,7 @@ module SafetyKit
1892
1786
  optional :resources_used,
1893
1787
  -> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::ResourcesUsed] }
1894
1788
 
1895
- # @!method initialize(event_name:, timestamp:, user_id:, content: nil, metadata: nil, properties: nil, resources_used: nil, type: :create_account)
1789
+ # @!method initialize(event_name:, timestamp:, user_id:, content: nil, metadata: nil, resources_used: nil, type: :create_account)
1896
1790
  # Some parameter documentations has been truncated, see
1897
1791
  # {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount}
1898
1792
  # for more details.
@@ -1909,8 +1803,6 @@ module SafetyKit
1909
1803
  #
1910
1804
  # @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
1911
1805
  #
1912
- # @param properties [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Properties] Stable, typed account-level facts SafetyKit can use in rules and aggregate analy
1913
- #
1914
1806
  # @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
1915
1807
  #
1916
1808
  # @param type [Symbol, :create_account]
@@ -2083,45 +1975,6 @@ module SafetyKit
2083
1975
  ]
2084
1976
  end
2085
1977
 
2086
- # @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount#properties
2087
- class Properties < SafetyKit::Internal::Type::BaseModel
2088
- # @!attribute account_state
2089
- # Current account lifecycle or moderation state.
2090
- #
2091
- # @return [String, nil]
2092
- optional :account_state, String
2093
-
2094
- # @!attribute account_types
2095
- # Stable account categories in your product.
2096
- #
2097
- # @return [Array<String>, nil]
2098
- optional :account_types, SafetyKit::Internal::Type::ArrayOf[String]
2099
-
2100
- # @!attribute country
2101
- # Country associated with the account.
2102
- #
2103
- # @return [String, nil]
2104
- optional :country, String
2105
-
2106
- # @!attribute email_verified
2107
- # Whether the account's email address has been verified.
2108
- #
2109
- # @return [Boolean, nil]
2110
- optional :email_verified, SafetyKit::Internal::Type::Boolean
2111
-
2112
- # @!method initialize(account_state: nil, account_types: nil, country: nil, email_verified: nil)
2113
- # Stable, typed account-level facts SafetyKit can use in rules and aggregate
2114
- # analysis.
2115
- #
2116
- # @param account_state [String] Current account lifecycle or moderation state.
2117
- #
2118
- # @param account_types [Array<String>] Stable account categories in your product.
2119
- #
2120
- # @param country [String] Country associated with the account.
2121
- #
2122
- # @param email_verified [Boolean] Whether the account's email address has been verified.
2123
- end
2124
-
2125
1978
  class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
2126
1979
  # @!attribute type
2127
1980
  # Resource family, such as email, phone, name, address, url, instagram, tiktok,
@@ -2193,14 +2046,6 @@ module SafetyKit
2193
2046
  optional :metadata,
2194
2047
  -> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Metadata] }
2195
2048
 
2196
- # @!attribute properties
2197
- # Stable, typed account-level facts SafetyKit can use in rules and aggregate
2198
- # analysis.
2199
- #
2200
- # @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Properties, nil]
2201
- optional :properties,
2202
- -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Properties }
2203
-
2204
2049
  # @!attribute resources_used
2205
2050
  # Reusable resources observed during the event. Use this for emails, phone
2206
2051
  # numbers, names, addresses, social handles, URLs, payment identifiers, or similar
@@ -2210,7 +2055,7 @@ module SafetyKit
2210
2055
  optional :resources_used,
2211
2056
  -> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::ResourcesUsed] }
2212
2057
 
2213
- # @!method initialize(event_name:, timestamp:, user_id:, content: nil, metadata: nil, properties: nil, resources_used: nil, type: :update_account)
2058
+ # @!method initialize(event_name:, timestamp:, user_id:, content: nil, metadata: nil, resources_used: nil, type: :update_account)
2214
2059
  # Some parameter documentations has been truncated, see
2215
2060
  # {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount}
2216
2061
  # for more details.
@@ -2228,8 +2073,6 @@ module SafetyKit
2228
2073
  #
2229
2074
  # @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
2230
2075
  #
2231
- # @param properties [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Properties] Stable, typed account-level facts SafetyKit can use in rules and aggregate analy
2232
- #
2233
2076
  # @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
2234
2077
  #
2235
2078
  # @param type [Symbol, :update_account]
@@ -2402,45 +2245,6 @@ module SafetyKit
2402
2245
  ]
2403
2246
  end
2404
2247
 
2405
- # @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount#properties
2406
- class Properties < SafetyKit::Internal::Type::BaseModel
2407
- # @!attribute account_state
2408
- # Current account lifecycle or moderation state.
2409
- #
2410
- # @return [String, nil]
2411
- optional :account_state, String
2412
-
2413
- # @!attribute account_types
2414
- # Stable account categories in your product.
2415
- #
2416
- # @return [Array<String>, nil]
2417
- optional :account_types, SafetyKit::Internal::Type::ArrayOf[String]
2418
-
2419
- # @!attribute country
2420
- # Country associated with the account.
2421
- #
2422
- # @return [String, nil]
2423
- optional :country, String
2424
-
2425
- # @!attribute email_verified
2426
- # Whether the account's email address has been verified.
2427
- #
2428
- # @return [Boolean, nil]
2429
- optional :email_verified, SafetyKit::Internal::Type::Boolean
2430
-
2431
- # @!method initialize(account_state: nil, account_types: nil, country: nil, email_verified: nil)
2432
- # Stable, typed account-level facts SafetyKit can use in rules and aggregate
2433
- # analysis.
2434
- #
2435
- # @param account_state [String] Current account lifecycle or moderation state.
2436
- #
2437
- # @param account_types [Array<String>] Stable account categories in your product.
2438
- #
2439
- # @param country [String] Country associated with the account.
2440
- #
2441
- # @param email_verified [Boolean] Whether the account's email address has been verified.
2442
- end
2443
-
2444
2248
  class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
2445
2249
  # @!attribute type
2446
2250
  # Resource family, such as email, phone, name, address, url, instagram, tiktok,
@@ -7,24 +7,85 @@ module SafetyKit
7
7
  extend SafetyKit::Internal::Type::RequestParameters::Converter
8
8
  include SafetyKit::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute customer_session_hash
11
- # Hashed customer browser session value associated with the browser SDK session.
10
+ # @!attribute body
11
+ # Request body for creating a browser-safe webapp SDK session token from
12
+ # server-side code. Provide at least one of customer_user_id or
13
+ # customer_session_hash.
12
14
  #
13
- # @return [String, nil]
14
- optional :customer_session_hash, String
15
+ # @return [SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember0, SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember1, nil]
16
+ optional :body, union: -> { SafetyKit::ClientSessionCreateSessionParams::Body }
15
17
 
16
- # @!attribute customer_user_id
17
- # Customer user identifier associated with the browser SDK session.
18
+ # @!method initialize(body: nil, request_options: {})
19
+ # Some parameter documentations has been truncated, see
20
+ # {SafetyKit::Models::ClientSessionCreateSessionParams} for more details.
18
21
  #
19
- # @return [String, nil]
20
- optional :customer_user_id, String
21
-
22
- # @!method initialize(customer_session_hash: nil, customer_user_id: nil, request_options: {})
23
- # @param customer_session_hash [String] Hashed customer browser session value associated with the browser SDK session.
24
- #
25
- # @param customer_user_id [String] Customer user identifier associated with the browser SDK session.
22
+ # @param body [SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember0, SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember1] Request body for creating a browser-safe webapp SDK session token from server-si
26
23
  #
27
24
  # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}]
25
+
26
+ # Request body for creating a browser-safe webapp SDK session token from
27
+ # server-side code. Provide at least one of customer_user_id or
28
+ # customer_session_hash.
29
+ module Body
30
+ extend SafetyKit::Internal::Type::Union
31
+
32
+ variant -> { SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember0 }
33
+
34
+ variant -> { SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember1 }
35
+
36
+ class UnionMember0 < SafetyKit::Internal::Type::BaseModel
37
+ # @!attribute customer_user_id
38
+ # Customer user identifier associated with the browser SDK session. Use the same
39
+ # canonical user ID string that you send as user_id in SafetyKit server-to-server
40
+ # events.
41
+ #
42
+ # @return [String]
43
+ required :customer_user_id, String
44
+
45
+ # @!attribute customer_session_hash
46
+ # Stable opaque customer session hash associated with the browser SDK session.
47
+ #
48
+ # @return [String, nil]
49
+ optional :customer_session_hash, String
50
+
51
+ # @!method initialize(customer_user_id:, customer_session_hash: nil)
52
+ # Some parameter documentations has been truncated, see
53
+ # {SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember0} for
54
+ # more details.
55
+ #
56
+ # @param customer_user_id [String] Customer user identifier associated with the browser SDK session. Use the same c
57
+ #
58
+ # @param customer_session_hash [String] Stable opaque customer session hash associated with the browser SDK session.
59
+ end
60
+
61
+ class UnionMember1 < SafetyKit::Internal::Type::BaseModel
62
+ # @!attribute customer_session_hash
63
+ # Stable opaque customer session hash associated with the browser SDK session.
64
+ #
65
+ # @return [String]
66
+ required :customer_session_hash, String
67
+
68
+ # @!attribute customer_user_id
69
+ # Customer user identifier associated with the browser SDK session. Use the same
70
+ # canonical user ID string that you send as user_id in SafetyKit server-to-server
71
+ # events.
72
+ #
73
+ # @return [String, nil]
74
+ optional :customer_user_id, String
75
+
76
+ # @!method initialize(customer_session_hash:, customer_user_id: nil)
77
+ # Some parameter documentations has been truncated, see
78
+ # {SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember1} for
79
+ # more details.
80
+ #
81
+ # @param customer_session_hash [String] Stable opaque customer session hash associated with the browser SDK session.
82
+ #
83
+ # @param customer_user_id [String] Customer user identifier associated with the browser SDK session. Use the same c
84
+ end
85
+
86
+ # @!method self.variants
87
+ # @return [Array(SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember0, SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember1)]
88
+ end
28
89
  end
29
90
  end
30
91
  end
@@ -5,15 +5,19 @@ module SafetyKit
5
5
  # Create browser-safe webapp SDK session tokens from authenticated server-side
6
6
  # code.
7
7
  class ClientSessions
8
- # Create a browser-safe SafetyKit webapp SDK session token from server-side code
9
- # before rendering pages that load the browser SDK. The request must be
10
- # authenticated with a valid Bearer token.
8
+ # Some parameter documentations has been truncated, see
9
+ # {SafetyKit::Models::ClientSessionCreateSessionParams} for more details.
11
10
  #
12
- # @overload create_session(customer_session_hash: nil, customer_user_id: nil, request_options: {})
11
+ # Create a browser-safe SafetyKit webapp SDK session token from server-side code
12
+ # before rendering pages that load the browser SDK. Provide at least one of
13
+ # customer_user_id or customer_session_hash. When customer_user_id is present, use
14
+ # the same canonical user ID string that you send as user_id in SafetyKit
15
+ # server-to-server events. The request must be authenticated with a valid Bearer
16
+ # token.
13
17
  #
14
- # @param customer_session_hash [String] Hashed customer browser session value associated with the browser SDK session.
18
+ # @overload create_session(body: nil, request_options: {})
15
19
  #
16
- # @param customer_user_id [String] Customer user identifier associated with the browser SDK session.
20
+ # @param body [SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember0, SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember1] Request body for creating a browser-safe webapp SDK session token from server-si
17
21
  #
18
22
  # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
19
23
  #
@@ -26,7 +30,7 @@ module SafetyKit
26
30
  @client.request(
27
31
  method: :post,
28
32
  path: path,
29
- body: parsed,
33
+ body: parsed[:body],
30
34
  model: SafetyKit::Models::ClientSessionCreateSessionResponse,
31
35
  options: options
32
36
  )
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module SafetyKit
4
- VERSION = "0.8.0"
4
+ VERSION = "0.10.0"
5
5
  end