growsurf-python 1.18.0__py3-none-any.whl → 1.19.0__py3-none-any.whl

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.
growsurf/_version.py CHANGED
@@ -1,4 +1,4 @@
1
1
  # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  __title__ = "growsurf"
4
- __version__ = "1.18.0" # x-release-please-version
4
+ __version__ = "1.19.0" # x-release-please-version
@@ -487,8 +487,8 @@ class CampaignResource(SyncAPIResource):
487
487
  is_affiliate: Affiliate programs only. Controls affiliate enrollment for a new participant.
488
488
 
489
489
  language: The language of the participant's portal and program emails. Stored when it is one of
490
- the program's languages. A regional tag maps to its language (for example, `es-MX` is
491
- stored as `es`). Any other value is ignored and the program's base language applies.
490
+ the program's languages. A regional tag maps to its language (for example, `fr-BE` is
491
+ stored as `fr`). Any other value is ignored and the program's base language applies.
492
492
  Applied only when this request creates the participant.
493
493
 
494
494
  referred_at: When the participant was referred, in Unix milliseconds. Used only with a valid
@@ -1732,8 +1732,8 @@ class AsyncCampaignResource(AsyncAPIResource):
1732
1732
  is_affiliate: Affiliate programs only. Controls affiliate enrollment for a new participant.
1733
1733
 
1734
1734
  language: The language of the participant's portal and program emails. Stored when it is one of
1735
- the program's languages. A regional tag maps to its language (for example, `es-MX` is
1736
- stored as `es`). Any other value is ignored and the program's base language applies.
1735
+ the program's languages. A regional tag maps to its language (for example, `fr-BE` is
1736
+ stored as `fr`). Any other value is ignored and the program's base language applies.
1737
1737
  Applied only when this request creates the participant.
1738
1738
 
1739
1739
  referred_at: When the participant was referred, in Unix milliseconds. Used only with a valid
@@ -337,8 +337,8 @@ class ParticipantResource(SyncAPIResource):
337
337
  unchanged.
338
338
 
339
339
  language: The language of the participant's portal and program emails. Stored when it is one of
340
- the program's languages. A regional tag maps to its language (for example, `es-MX` is
341
- stored as `es`). Any other value is ignored and the program's base language applies.
340
+ the program's languages. A regional tag maps to its language (for example, `fr-BE` is
341
+ stored as `fr`). Any other value is ignored and the program's base language applies.
342
342
  Applied only when this request creates the participant.
343
343
 
344
344
  metadata: Shallow custom metadata object.
@@ -1624,8 +1624,8 @@ class AsyncParticipantResource(AsyncAPIResource):
1624
1624
  unchanged.
1625
1625
 
1626
1626
  language: The language of the participant's portal and program emails. Stored when it is one of
1627
- the program's languages. A regional tag maps to its language (for example, `es-MX` is
1628
- stored as `es`). Any other value is ignored and the program's base language applies.
1627
+ the program's languages. A regional tag maps to its language (for example, `fr-BE` is
1628
+ stored as `fr`). Any other value is ignored and the program's base language applies.
1629
1629
  Applied only when this request creates the participant.
1630
1630
 
1631
1631
  metadata: Shallow custom metadata object.
@@ -46,4 +46,6 @@ Language: TypeAlias = Literal[
46
46
  "fil",
47
47
  "af",
48
48
  "sw",
49
+ "zh-TW",
50
+ "es-419",
49
51
  ]
@@ -32,7 +32,7 @@ class ParticipantAddParams(TypedDict, total=False):
32
32
  """The language of the participant's portal and program emails.
33
33
 
34
34
  Stored when it is one of the program's languages. A regional tag maps to its
35
- language (for example, `es-MX` is stored as `es`). Any other value is ignored and
35
+ language (for example, `fr-BE` is stored as `fr`). Any other value is ignored and
36
36
  the program's base language applies. Applied only when this request creates the
37
37
  participant.
38
38
  """
@@ -23,6 +23,29 @@ class ParticipantReward(BaseModel):
23
23
  approved_at: Optional[int] = FieldInfo(alias="approvedAt", default=None)
24
24
 
25
25
  amount: Optional[float] = None
26
+ """What the reward is worth in major units of `currency_iso`.
27
+
28
+ `None` for a percent-off coupon or when no amount is available.
29
+ """
30
+
31
+ amount_source: Optional[
32
+ Literal[
33
+ "STRIPE",
34
+ "CHARGEBEE",
35
+ "RECURLY",
36
+ "CHARGIFY",
37
+ "PAYPAL",
38
+ "VENMO",
39
+ "TANGO_CARD",
40
+ "TREMENDOUS",
41
+ "XTRM",
42
+ "METADATA",
43
+ ]
44
+ ] = FieldInfo(alias="amountSource", default=None)
45
+ """Where `amount` or `percent_off` comes from.
46
+
47
+ `METADATA` means the amount saved when the reward was earned.
48
+ """
26
49
 
27
50
  commission_structure: Optional[CommissionStructure] = FieldInfo(alias="commissionStructure", default=None)
28
51
 
@@ -36,6 +59,9 @@ class ParticipantReward(BaseModel):
36
59
 
37
60
  is_referrer: Optional[bool] = FieldInfo(alias="isReferrer", default=None)
38
61
 
62
+ percent_off: Optional[float] = FieldInfo(alias="percentOff", default=None)
63
+ """Discount of a percent-off coupon (`20` = 20% off); `None` for every other reward."""
64
+
39
65
  referred_id: Optional[str] = FieldInfo(alias="referredId", default=None)
40
66
 
41
67
  referrer_id: Optional[str] = FieldInfo(alias="referrerId", default=None)
@@ -32,7 +32,7 @@ class CampaignCreateMobileParticipantTokenParams(TypedDict, total=False):
32
32
  """The language of the participant's portal and program emails.
33
33
 
34
34
  Stored when it is one of the program's languages. A regional tag maps to its
35
- language (for example, `es-MX` is stored as `es`). Any other value is ignored and
35
+ language (for example, `fr-BE` is stored as `fr`). Any other value is ignored and
36
36
  the program's base language applies. Applied only when this request creates the
37
37
  participant.
38
38
  """
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: growsurf-python
3
- Version: 1.18.0
3
+ Version: 1.19.0
4
4
  Summary: The official Python library for the growsurf API
5
5
  Project-URL: Homepage, https://growsurf.com/
6
6
  Project-URL: Repository, https://github.com/growsurf/growsurf-python
@@ -11,7 +11,7 @@ growsurf/_resource.py,sha256=oeDA0FL2ottIchoUi86M_8eUqmtrGQLYTgfKYEzrsWg,1112
11
11
  growsurf/_response.py,sha256=RTZ8t27W4S6ExkCjzCg4HbcDUTCdOMgiheiMAuAxgu4,28937
12
12
  growsurf/_streaming.py,sha256=9aJ_V6JtddntWCon2Cq_MOLMnySnhc7wuqeZx7sUtKU,10558
13
13
  growsurf/_types.py,sha256=r8hAVihrutiLUToaJhSDys9T9sMc8BMy2qUrr3W_8Wo,7751
14
- growsurf/_version.py,sha256=bwsaxJtQs4pls0A7nOwW-4UN2SxvxBCl6fZ7NbXhqbU,161
14
+ growsurf/_version.py,sha256=0HPtKfQXDoKoFhJk2AVJKlowcGv1X6j_GxsOEnS070k,161
15
15
  growsurf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
16
16
  growsurf/_utils/__init__.py,sha256=nQq-iFa5YxTaWySaLigatew5rHgTR0M75FNYm4mrO1s,2313
17
17
  growsurf/_utils/_compat.py,sha256=33246eDcl3pwL6kWsEhVuT4Akrd8gZEW9LPTm465ohk,1231
@@ -31,7 +31,7 @@ growsurf/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
31
31
  growsurf/resources/__init__.py,sha256=MMpB55-oMmzcTRlAiP8CDC1VIJ4vG84ImWZHfvfvrmE,1002
32
32
  growsurf/resources/team.py,sha256=t0QN7d9BplF6N2Np0sHcmIcPNjJXs7OcZ1OvUN1g1c8,15801
33
33
  growsurf/resources/campaign/__init__.py,sha256=Rj89RbcI0Aexw0ZgEUvbsQ4FexYhrlBAFppZRTRSuI0,6513
34
- growsurf/resources/campaign/campaign.py,sha256=uerXO3NziqrAIgSgWdUqS47zgxzA6UWp1essY8IQmzY,133995
34
+ growsurf/resources/campaign/campaign.py,sha256=MGy0C1HNn-qIK11M69krtRBB2P5aNMITIDtnuUDAKP8,133995
35
35
  growsurf/resources/campaign/commission.py,sha256=Li8L2l8xRh4EXa_oD7R9RJ6m4xaA4pmt9gXTxib2Fkk,10426
36
36
  growsurf/resources/campaign/custom_domain.py,sha256=5O5DDRAXSX_eFVqGEgj_Vt9rjyoiBwuxwNo0JxUNPB8,18923
37
37
  growsurf/resources/campaign/design.py,sha256=rNfRc4PfDAz1-6w4cAp_4kDo389RnMidEA6zBxnbkyQ,12902
@@ -39,7 +39,7 @@ growsurf/resources/campaign/emails.py,sha256=X6DHJok1qWSxoH0F2bfFPnUoSiRYxbcQeVc
39
39
  growsurf/resources/campaign/installation.py,sha256=9gcxGpvc1aZXj5Sbwxnv6LGr3T9USyfhWdAB8gSXmdM,11616
40
40
  growsurf/resources/campaign/integrations.py,sha256=Hm88oAzXF7sM4111rfiojH-Tqye4I9yLxcQQnUF4ssI,7649
41
41
  growsurf/resources/campaign/options.py,sha256=ROQNy7kxPfKAKxEOgOkVLZB7__ZVBaGXhcm7GWxkjQA,12054
42
- growsurf/resources/campaign/participant.py,sha256=HxdDOWVP4W8bJzGepfdyA2ms-WhvCk5crixMVEV9bpc,129278
42
+ growsurf/resources/campaign/participant.py,sha256=Ylm_Hv5Z2ZVapwlT0sZkj9LINfkM-7Y6CjSDvybocpE,129278
43
43
  growsurf/resources/campaign/program_resources.py,sha256=e6ANK-_kuU5YTMQwKCCt35iOtooYwYPFR8AvJFDsTNA,17521
44
44
  growsurf/resources/campaign/reward.py,sha256=XM-kRIpFi_ofXoMfq20iDc_3Pyp-B1wiMXlbcukknec,14322
45
45
  growsurf/resources/campaign/rewards.py,sha256=YFORkFU4S4DR4-hUJA56a--WDSQjuAewS-fAH7Ya0AI,47075
@@ -54,7 +54,7 @@ growsurf/types/analytics_availability.py,sha256=WAwYl-B-UuI4s1pHs3dmL-yOe2eYPquk
54
54
  growsurf/types/analytics_unavailable_reason.py,sha256=AjYjGjaeod3M8xvqwk_BU_q42dFDh8SSoTNzK3_lgpc,416
55
55
  growsurf/types/campaign_activation_analytics_response.py,sha256=xQWzx1qIzJtN6Ai6zCiGScCLJXaRDhCIBzBC4sIrRnU,5334
56
56
  growsurf/types/campaign_create_affiliate_invite_params.py,sha256=_LO57fk6qNxMSt5mfmLOZLbEqBUxJYIQlMsEZYreDTY,690
57
- growsurf/types/campaign_create_mobile_participant_token_params.py,sha256=fUxJ7DCYfwoN4T2d6uT1JM5jBVDGpzAUZtk43U_2ifU,2360
57
+ growsurf/types/campaign_create_mobile_participant_token_params.py,sha256=e4ow4ukQoZ7qWu1rols-cirkuNON4D08hd7YR6f8KwM,2360
58
58
  growsurf/types/campaign_create_mobile_participant_token_response.py,sha256=IvIgtizBufLI-p9pk7MnyJj3XydHjLvdoAw-PWpPqdI,769
59
59
  growsurf/types/campaign_create_params.py,sha256=4S_TcS3ayucppF3dwlEUxDfKelPwJsziZLTks8ijZrA,3375
60
60
  growsurf/types/campaign_engagement_analytics.py,sha256=64WQ6cmdwvNE8I-a8rMCjEe_umEHV5puOcHQy_MsjH8,6399
@@ -102,11 +102,11 @@ growsurf/types/campaign/email_participant_response.py,sha256=A6i_s-YZnS8zYcKbMlZ
102
102
  growsurf/types/campaign/fraud_risk_level.py,sha256=e14xAEYtKH6gGnkJ9-sr81GZ2UY-zDQ6TZKCkBJLagw,228
103
103
  growsurf/types/campaign/integration.py,sha256=MIBG_M_zQJ_KHd-w_nCgCvP62o8eY0Q-IKwP-rzJ_oM,1223
104
104
  growsurf/types/campaign/integration_list_response.py,sha256=w09nrHrwarPJsDmNDxcDgMFsesAAF5H6leueoET6wNU,417
105
- growsurf/types/campaign/language.py,sha256=qGzy1qPBhszcibeipvauSeCJ7rn0v5FCb_zGP61R_e4,705
105
+ growsurf/types/campaign/language.py,sha256=5IIY8Ku7Tf7kGIRAhzS4pOUZ_2GiEHj5YZlEkckon3M,732
106
106
  growsurf/types/campaign/participant.py,sha256=XNetw_GU3GOVzsmldNs9S3rLyPeT_AvHzHwD9RQ-Zcw,6540
107
107
  growsurf/types/campaign/participant_activation_analytics.py,sha256=AB5Bdy60t-nc3_INVw03TKpp63lllutw8mSNPLZro7w,2686
108
108
  growsurf/types/campaign/participant_activity_logs_response.py,sha256=W-inUKJZimgwGlL6FqGlyQxG-XC9H7fnYMHtVi__uAQ,783
109
- growsurf/types/campaign/participant_add_params.py,sha256=cV8NruFX6V9fSZsTSH7NQed3RSzACEzjijDAD_PfxXo,2578
109
+ growsurf/types/campaign/participant_add_params.py,sha256=qiGcnbHR-eCJrTKFIC9EgBqWD6DH4ebc-zzQ5Ll7gcM,2578
110
110
  growsurf/types/campaign/participant_analytics_params.py,sha256=ZIBCKhL6vRw2EfmxOItWgDPVI7XFg7LsMaD_mU-Kckg,1839
111
111
  growsurf/types/campaign/participant_analytics_response.py,sha256=3cV3vqwt-k-L-C5CQpTXQhGDm1bbi5oCiviNnBpLr5Y,6782
112
112
  growsurf/types/campaign/participant_bulk_delete_params.py,sha256=U2tI2cUSardUuWXLxa4dWCuJGvcN5PmBxC53iqDgf-g,469
@@ -126,7 +126,7 @@ growsurf/types/campaign/participant_refund_transaction_params.py,sha256=z8G2swRh
126
126
  growsurf/types/campaign/participant_refund_transaction_response.py,sha256=0rrtiALlVTN7JpkBNQx9oiwd_JXC_jdCQJf2HzLG50I,699
127
127
  growsurf/types/campaign/participant_request_payout_destination_confirmation_params.py,sha256=9D-af7KC5-PDslnV9XrvBe7-WrjPEcGcAc18Ksb719I,503
128
128
  growsurf/types/campaign/participant_request_payout_destination_confirmation_response.py,sha256=sI6wlsyNvsx7yv7T4vXuA2jINqDNjNY5ekmqyP12Vbo,843
129
- growsurf/types/campaign/participant_reward.py,sha256=L4fN1LeAfVdR3qAoF0zhzNypP8BjFOywoe79QVDxCmU,1329
129
+ growsurf/types/campaign/participant_reward.py,sha256=kR6MQk6OZrwKND4fbCrqWzKQOlXdWcHmfsDxMbKKxGU,2114
130
130
  growsurf/types/campaign/participant_send_invites_params.py,sha256=Jr21i0OvqSCYVnWsmy5xVu2g7BhGahF-5ompc5Hm9hk,644
131
131
  growsurf/types/campaign/participant_send_invites_response.py,sha256=kxqP0EhbFN6dC0P7na7fWYkxhSRD5vhQ-INgGxTr9n8,388
132
132
  growsurf/types/campaign/participant_trigger_referral_params.py,sha256=CsjLpiwuBLBa7zpObaKXMV8uLfNtjd0A0K63Ev5Nrpw,778
@@ -154,7 +154,7 @@ growsurf/types/campaign/webhook_list_response.py,sha256=tSk9nTbcsj5Y-j4RjQwu9SZc
154
154
  growsurf/types/campaign/webhook_test_params.py,sha256=X1Osg9-4KGJbZauG_7rDqTE7cKCypeSzgumIhnxj9dk,468
155
155
  growsurf/types/campaign/webhook_test_response.py,sha256=AahcckKSLUeIgpwlosOOmbkioF62xREXgLbieHAPAdI,576
156
156
  growsurf/types/campaign/webhook_update_params.py,sha256=SavKhws8pfybC7O40ovtCreEmOwihEGPOCEX9Iua9cE,598
157
- growsurf_python-1.18.0.dist-info/METADATA,sha256=9Mrc_O5dbGgn6CXfpLXU-JW2TMpO-lZp49DvMZJYcnk,13950
158
- growsurf_python-1.18.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
159
- growsurf_python-1.18.0.dist-info/licenses/LICENSE,sha256=kTHLVE-ra1gtTxcn395uFqcOzcErebE-mDdPNW7b8OU,11338
160
- growsurf_python-1.18.0.dist-info/RECORD,,
157
+ growsurf_python-1.19.0.dist-info/METADATA,sha256=j26ELhp7c2sgn93a8So-1JNw5P9Iqco1KBTcl81RuaM,13950
158
+ growsurf_python-1.19.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
159
+ growsurf_python-1.19.0.dist-info/licenses/LICENSE,sha256=kTHLVE-ra1gtTxcn395uFqcOzcErebE-mDdPNW7b8OU,11338
160
+ growsurf_python-1.19.0.dist-info/RECORD,,