outerjoyn 2.0.0__tar.gz → 3.0.0__tar.gz

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 (45) hide show
  1. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/CHANGELOG.md +37 -0
  2. {outerjoyn-2.0.0/outerjoyn.egg-info → outerjoyn-3.0.0}/PKG-INFO +1 -1
  3. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/__init__.py +1 -1
  4. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/_generated/models.py +58 -17
  5. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/_http.py +28 -5
  6. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/partnerships.py +7 -4
  7. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/pay.py +3 -1
  8. {outerjoyn-2.0.0 → outerjoyn-3.0.0/outerjoyn.egg-info}/PKG-INFO +1 -1
  9. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/pyproject.toml +1 -1
  10. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/MANIFEST.in +0 -0
  11. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/README.md +0 -0
  12. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/_generated/__init__.py +0 -0
  13. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/client.py +0 -0
  14. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/errors.py +0 -0
  15. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/models.py +0 -0
  16. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/py.typed +0 -0
  17. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/__init__.py +0 -0
  18. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/accounts.py +0 -0
  19. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/api_keys.py +0 -0
  20. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/approvals.py +0 -0
  21. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/balance.py +0 -0
  22. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/batch.py +0 -0
  23. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/catalog.py +0 -0
  24. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/changes.py +0 -0
  25. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/contacts.py +0 -0
  26. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/contracts.py +0 -0
  27. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/earn.py +0 -0
  28. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/exchange.py +0 -0
  29. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/exports.py +0 -0
  30. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/fraud_rules.py +0 -0
  31. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/ingest.py +0 -0
  32. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/integrations.py +0 -0
  33. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/members.py +0 -0
  34. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/objects.py +0 -0
  35. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/promotions.py +0 -0
  36. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/redeem.py +0 -0
  37. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/sessions.py +0 -0
  38. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/subscriptions.py +0 -0
  39. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/resources/tasks.py +0 -0
  40. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn/webhooks.py +0 -0
  41. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn.egg-info/SOURCES.txt +0 -0
  42. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn.egg-info/dependency_links.txt +0 -0
  43. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn.egg-info/requires.txt +0 -0
  44. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/outerjoyn.egg-info/top_level.txt +0 -0
  45. {outerjoyn-2.0.0 → outerjoyn-3.0.0}/setup.cfg +0 -0
@@ -1,5 +1,42 @@
1
1
  # Changelog
2
2
 
3
+ ## 3.0.0 — 2026-11-04
4
+
5
+ ### Changed
6
+ - **A purchase refused as busy is sent again.** When OuterJoyn answers a POST
7
+ with `503` and error code `overloaded` (nothing was saved), the SDK waits the
8
+ `Retry-After` seconds (at most 10) and sends it again, up to `max_retries`
9
+ times. Other POST failures are still not resent.
10
+
11
+ ### Added
12
+ - **A reservation's `status` lists `expired`, not `refunded`.** A checkout
13
+ reservation is `held`, `confirmed`, `released` or `expired`; `refunded` was
14
+ never returned.
15
+ - **Allowed values on more fields.** The generated types now list the allowed
16
+ values of a payment term's `payer`, `funded_by` and `funding`, a fraud rule's
17
+ `rule_type`, and a connection's `protocol`.
18
+
19
+ ### Changed (breaking)
20
+ - **`client.pay.get_session()` returns its ids as strings.** `payment_session_id`,
21
+ `sdk_session_id`, `business_unit_id`, `member_id` and `retailer_brand_id`
22
+ are strings, because they exceed 2^53 and a JSON number lost precision.
23
+ Amounts stay numbers.
24
+ - **`client.pay.get_session()` is typed as what the API returns.** The response is
25
+ `{ session }`: the stored session with snake_case fields (`status`,
26
+ `merchant_order_id`, `order_total_amount`, …). It never carried
27
+ `reservations` or camelCase fields; checkout returns the reservations.
28
+ - **Refund lines add up to the refund.** On `refund-by-order`, each entry in
29
+ `lines` needs `amountCents`, and the lines must sum to the refund
30
+ (`422 refund_lines_amount_mismatch` otherwise). A new `kind`
31
+ (`merchandise` | `shipping` | `tax` | `fee` | `adjustment`) covers the parts of
32
+ a refund that aren't returned merchandise; `lineRef` is required only on
33
+ merchandise lines.
34
+ - **`partnerships.members()` pages by cursor.** Pass a page's `next_cursor` as
35
+ `cursor` to get the next page (`next_cursor` is null on the last page). The
36
+ `offset` parameter and the `total` / `offset` fields are gone: counting and
37
+ skipping every linked customer on each page did not hold up for partnerships
38
+ with millions of links.
39
+
3
40
  ## 2.0.0 — 2026-10-20
4
41
 
5
42
  ### Changed (breaking)
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: outerjoyn
3
- Version: 2.0.0
3
+ Version: 3.0.0
4
4
  Summary: OuterJoyn Python SDK for loyalty point payments and rewards
5
5
  License: MIT
6
6
  Project-URL: Homepage, https://docs.outerjoyn.com
@@ -11,7 +11,7 @@ from outerjoyn.errors import (
11
11
  )
12
12
  from outerjoyn.webhooks import Webhook
13
13
 
14
- __version__ = "2.0.0"
14
+ __version__ = "3.0.0"
15
15
  __all__ = [
16
16
  "Client",
17
17
  "Webhook",
@@ -97,9 +97,12 @@ class CreateSessionRequest(TypedDict):
97
97
  partner_member_id: str
98
98
  partnership_id: NotRequired[str]
99
99
  brand_program_id: NotRequired[str]
100
+ customer_signature: NotRequired[str]
101
+ customer_signed_at: NotRequired[int]
100
102
  identity_hints: NotRequired[IdentityHints]
101
103
  scopes: NotRequired[list[Literal['balance:read', 'exchange', 'redeem', 'link', 'earn', 'pay']]]
102
104
  ttl_minutes: NotRequired[int]
105
+ create_customer_if_missing: NotRequired[bool]
103
106
 
104
107
 
105
108
  class Legal(TypedDict):
@@ -158,7 +161,14 @@ class Reservation(TypedDict):
158
161
  pointsReserved: float
159
162
  valueCents: int
160
163
  pointValueAmount: float
161
- status: Literal['held', 'confirmed', 'released', 'refunded']
164
+ status: Literal['held', 'confirmed', 'released', 'expired']
165
+
166
+
167
+ class PayLegCharge(TypedDict):
168
+ currencyId: str
169
+ pointsAmount: float
170
+ amountCents: int
171
+ pointValueAmount: float
162
172
 
163
173
 
164
174
  class SplitCheck(TypedDict):
@@ -194,9 +204,10 @@ class RefundResponse(TypedDict):
194
204
 
195
205
 
196
206
  class RefundLineRef(TypedDict):
197
- lineRef: str
207
+ kind: NotRequired[Literal['merchandise', 'shipping', 'tax', 'fee', 'adjustment']]
208
+ lineRef: NotRequired[str]
198
209
  quantity: NotRequired[int]
199
- amountCents: NotRequired[int]
210
+ amountCents: int
200
211
 
201
212
 
202
213
  class RefundByOrderLeg(TypedDict):
@@ -224,15 +235,31 @@ class RefundByOrderResponse(TypedDict):
224
235
  lines: NotRequired[list[RefundLineRef]]
225
236
 
226
237
 
227
- class PaymentSession(TypedDict):
228
- paymentSessionId: str
229
- status: Literal['open', 'pending_fraud_review', 'confirmed', 'expired', 'cancelled']
230
- merchantOrderId: str
231
- orderTotalCents: float
232
- totalReservedCents: int
233
- createdAt: str
234
- expiresAt: str
235
- reservations: list[Reservation]
238
+ class PaymentSessionRecord(TypedDict):
239
+ payment_session_id: str
240
+ sdk_session_id: NotRequired[str]
241
+ business_unit_id: NotRequired[str]
242
+ member_id: str
243
+ retailer_brand_id: NotRequired[str]
244
+ merchant_order_id: str
245
+ currency_code: str
246
+ status: Literal['open', 'reserved', 'confirmed', 'cancelled', 'expired', 'pending_fraud_review']
247
+ refund_policy: NotRequired[Literal['points_first', 'card_first', 'proportional', 'original_tender', 'points_only']]
248
+ application_mode: NotRequired[str]
249
+ order_total_amount: float
250
+ merchandise_subtotal_amount: NotRequired[float]
251
+ tax_amount: NotRequired[float]
252
+ shipping_amount: NotRequired[float]
253
+ max_points_applicable_amount: NotRequired[float]
254
+ redeem_include_tax: NotRequired[bool]
255
+ redeem_include_shipping: NotRequired[bool]
256
+ idempotency_key: NotRequired[str]
257
+ metadata: NotRequired[dict[str, Any]]
258
+ sandbox_id: NotRequired[int]
259
+ is_test: NotRequired[bool]
260
+ created_at: str
261
+ updated_at: str
262
+ expires_at: str
236
263
 
237
264
 
238
265
  class Item(TypedDict):
@@ -568,10 +595,9 @@ class PartnershipMember(TypedDict):
568
595
 
569
596
  class PartnershipMembersResponse(TypedDict):
570
597
  data: list[PartnershipMember]
571
- total: int
572
598
  limit: int
573
- offset: int
574
599
  has_more: bool
600
+ next_cursor: str
575
601
 
576
602
 
577
603
  class PartnershipDetailResponse(TypedDict):
@@ -585,6 +611,7 @@ class IngestMemberRecord(TypedDict):
585
611
  firstName: NotRequired[str]
586
612
  lastName: NotRequired[str]
587
613
  externalId: NotRequired[str]
614
+ identifiers: NotRequired[dict[str, str]]
588
615
  brandRef: NotRequired[str]
589
616
 
590
617
 
@@ -592,6 +619,7 @@ class IngestTransactionRecord(TypedDict):
592
619
  clientRef: NotRequired[str]
593
620
  idempotencyKey: NotRequired[str]
594
621
  memberRef: NotRequired[str]
622
+ memberMatchBy: NotRequired[list[str]]
595
623
  amount: NotRequired[int]
596
624
  currency: NotRequired[str]
597
625
  points: NotRequired[int]
@@ -644,7 +672,7 @@ class Connection(TypedDict):
644
672
  type: NotRequired[str]
645
673
  name: NotRequired[str]
646
674
  host: NotRequired[str]
647
- protocol: NotRequired[str]
675
+ protocol: NotRequired[Literal['ftp', 'sftp', 'ftps']]
648
676
  port: NotRequired[str]
649
677
  username: NotRequired[str]
650
678
  path: NotRequired[str]
@@ -914,7 +942,9 @@ class TaskLandingPageResponse(TypedDict):
914
942
  class PaymentTerm(TypedDict):
915
943
  payment_term_id: NotRequired[str]
916
944
  name: NotRequired[str]
917
- payer: NotRequired[str]
945
+ payer: NotRequired[Literal['brand', 'partner']]
946
+ funded_by: NotRequired[Literal['brand', 'partner', 'member', 'platform', 'sponsored', 'shared']]
947
+ funding: NotRequired[Literal['direct', 'post_pay', 'prefund', 'oj_fronts']]
918
948
  is_active: NotRequired[bool]
919
949
 
920
950
 
@@ -1027,6 +1057,9 @@ class ObjectFieldDescriptor(TypedDict):
1027
1057
  type: NotRequired[str]
1028
1058
  nullable: NotRequired[bool]
1029
1059
  foreign_key_table: NotRequired[str]
1060
+ writable: NotRequired[bool]
1061
+ required: NotRequired[bool]
1062
+ searchable: NotRequired[bool]
1030
1063
 
1031
1064
 
1032
1065
  class ObjectDescribeResponse(TypedDict):
@@ -1120,6 +1153,7 @@ class FraudRuleWriteRequest(TypedDict):
1120
1153
  evaluation_mode: NotRequired[Literal['inline', 'async']]
1121
1154
  is_enabled: NotRequired[bool]
1122
1155
  brand_ids: NotRequired[list[str]]
1156
+ partnership_id: NotRequired[str]
1123
1157
  config: NotRequired[dict[str, Any]]
1124
1158
 
1125
1159
 
@@ -1128,8 +1162,9 @@ class FraudRule(TypedDict):
1128
1162
  business_unit_id: NotRequired[str]
1129
1163
  brand_id: NotRequired[str]
1130
1164
  brand_ids: NotRequired[list[str]]
1165
+ partnership_id: NotRequired[str]
1131
1166
  rule_name: NotRequired[str]
1132
- rule_type: NotRequired[str]
1167
+ rule_type: NotRequired[Literal['velocity_accrual', 'velocity_redemption', 'velocity_exchange', 'velocity_transaction', 'amount_threshold', 'geo_anomaly', 'device_limit', 'ip_limit', 'account_linking_abuse', 'dormant_burst', 'network_risk', 'custom']]
1133
1168
  is_enabled: NotRequired[bool]
1134
1169
  config: NotRequired[dict[str, Any]]
1135
1170
 
@@ -1222,6 +1257,7 @@ class CreateSessionResponse(TypedDict):
1222
1257
  token: str
1223
1258
  status: Literal['active', 'ready', 'link_required']
1224
1259
  expires_at: str
1260
+ customer_created: NotRequired[bool]
1225
1261
  member_context: MemberContext
1226
1262
  payable_balances: list[PayableBalance]
1227
1263
  legal: Legal
@@ -1279,6 +1315,7 @@ class ConfirmPaymentResponse(TypedDict):
1279
1315
  status: Literal['confirmed']
1280
1316
  confirmedAt: str
1281
1317
  splitCheck: NotRequired[SplitCheck]
1318
+ charge: NotRequired[PayLegCharge]
1282
1319
 
1283
1320
 
1284
1321
  class RefundByOrderRequest(TypedDict):
@@ -1292,6 +1329,10 @@ class RefundByOrderRequest(TypedDict):
1292
1329
  lines: NotRequired[list[RefundLineRef]]
1293
1330
 
1294
1331
 
1332
+ class PaymentSession(TypedDict):
1333
+ session: PaymentSessionRecord
1334
+
1335
+
1295
1336
  class PromotionSetResolved(TypedDict):
1296
1337
  id: str
1297
1338
  name: str
@@ -8,7 +8,22 @@ import httpx
8
8
 
9
9
  from outerjoyn.errors import OuterJoynError, _create_error_from_response
10
10
 
11
- USER_AGENT = "outerjoyn-python/2.0.0"
11
+ USER_AGENT = "outerjoyn-python/3.0.0"
12
+
13
+
14
+ def _is_busy_answer(status: int, body: Any) -> bool:
15
+ """OuterJoyn's "busy" answer: refused before saving, safe to send again."""
16
+ err = body.get("error") if isinstance(body, dict) else None
17
+ return status == 503 and isinstance(err, dict) and err.get("code") == "overloaded"
18
+
19
+
20
+ def _retry_after_seconds(headers: Any) -> float:
21
+ """The Retry-After wait, with jitter, at most 10 s."""
22
+ try:
23
+ seconds = float(headers.get("Retry-After") or 0)
24
+ except ValueError:
25
+ seconds = 0
26
+ return min(seconds if seconds > 0 else 2.0, 10.0) + random.random() * 0.25
12
27
 
13
28
 
14
29
  class HTTPClient:
@@ -53,13 +68,18 @@ class HTTPClient:
53
68
  if params:
54
69
  params = {k: v for k, v in params.items() if v is not None}
55
70
 
56
- max_attempts = (self._max_retries + 1) if method.upper() == "GET" else 1
71
+ # GETs retry any failure. Other methods retry only OuterJoyn's "busy"
72
+ # answer (503, code "overloaded"), which is sent before anything is saved.
73
+ is_get = method.upper() == "GET"
74
+ max_attempts = self._max_retries + 1
57
75
  last_error: Optional[Exception] = None
76
+ wait: Optional[float] = None
58
77
 
59
78
  for attempt in range(max_attempts):
60
79
  if attempt > 0:
61
- delay = min(0.2 * (2 ** attempt) + random.random() * 0.1, 5.0)
80
+ delay = wait if wait is not None else min(0.2 * (2 ** attempt) + random.random() * 0.1, 5.0)
62
81
  time.sleep(delay)
82
+ wait = None
63
83
 
64
84
  try:
65
85
  response = self._client.request(
@@ -80,7 +100,10 @@ class HTTPClient:
80
100
  response.status_code, body, response.headers,
81
101
  )
82
102
 
83
- if response.status_code >= 500 and attempt < max_attempts - 1:
103
+ busy = _is_busy_answer(response.status_code, body)
104
+ if attempt < max_attempts - 1 and (busy or (is_get and response.status_code >= 500)):
105
+ if busy:
106
+ wait = _retry_after_seconds(response.headers)
84
107
  last_error = error
85
108
  continue
86
109
 
@@ -95,7 +118,7 @@ class HTTPClient:
95
118
  raise
96
119
  except httpx.HTTPError as e:
97
120
  last_error = e
98
- if attempt >= max_attempts - 1:
121
+ if not is_get or attempt >= max_attempts - 1:
99
122
  raise
100
123
 
101
124
  raise last_error or RuntimeError("Request failed")
@@ -153,14 +153,17 @@ class Partnerships:
153
153
  self,
154
154
  partnership_id: str,
155
155
  limit: Optional[int] = None,
156
- offset: Optional[int] = None,
156
+ cursor: Optional[str] = None,
157
157
  ) -> Dict[str, Any]:
158
- """List members linked through a partnership."""
158
+ """List members linked through a partnership, newest link first.
159
+
160
+ Pass a page's ``next_cursor`` as ``cursor`` to get the next page.
161
+ """
159
162
  params: Dict[str, Any] = {}
160
163
  if limit is not None:
161
164
  params["limit"] = limit
162
- if offset is not None:
163
- params["offset"] = offset
165
+ if cursor is not None:
166
+ params["cursor"] = cursor
164
167
  return self._http.get(
165
168
  f"{_BASE}/partnerships/{partnership_id}/members",
166
169
  params=params or None,
@@ -192,7 +192,9 @@ class Pay:
192
192
  def get_session(
193
193
  self, session_token: str, payment_session_id: Union[str, int]
194
194
  ) -> Dict[str, Any]:
195
- """Get payment session details."""
195
+ """Get the stored payment session as ``{"session": {...}}`` (snake_case
196
+ fields; poll ``session["status"]`` after a ``pending_fraud_review``
197
+ checkout). Its reservations are not included; checkout returns them."""
196
198
  return self._http.get(
197
199
  f"/api/sdk/pay/sessions/{payment_session_id}",
198
200
  bearer_token=session_token,
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: outerjoyn
3
- Version: 2.0.0
3
+ Version: 3.0.0
4
4
  Summary: OuterJoyn Python SDK for loyalty point payments and rewards
5
5
  License: MIT
6
6
  Project-URL: Homepage, https://docs.outerjoyn.com
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "outerjoyn"
7
- version = "2.0.0"
7
+ version = "3.0.0"
8
8
  description = "OuterJoyn Python SDK for loyalty point payments and rewards"
9
9
  readme = "README.md"
10
10
  license = {text = "MIT"}
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes