ordercloud-python 2026.4.1__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.
Files changed (114) hide show
  1. ordercloud/__init__.py +37 -0
  2. ordercloud/auth.py +136 -0
  3. ordercloud/client.py +211 -0
  4. ordercloud/config.py +42 -0
  5. ordercloud/errors.py +47 -0
  6. ordercloud/http.py +218 -0
  7. ordercloud/middleware.py +66 -0
  8. ordercloud/models/__init__.py +271 -0
  9. ordercloud/models/address.py +47 -0
  10. ordercloud/models/api_client.py +116 -0
  11. ordercloud/models/approval.py +73 -0
  12. ordercloud/models/assignments.py +402 -0
  13. ordercloud/models/auth_models.py +114 -0
  14. ordercloud/models/bundle.py +31 -0
  15. ordercloud/models/buyer.py +271 -0
  16. ordercloud/models/catalog.py +33 -0
  17. ordercloud/models/category.py +35 -0
  18. ordercloud/models/cost_center.py +27 -0
  19. ordercloud/models/credit_card.py +35 -0
  20. ordercloud/models/delivery.py +277 -0
  21. ordercloud/models/discount.py +63 -0
  22. ordercloud/models/integration.py +76 -0
  23. ordercloud/models/inventory_record.py +53 -0
  24. ordercloud/models/line_item.py +95 -0
  25. ordercloud/models/line_item_types.py +89 -0
  26. ordercloud/models/message_sender.py +80 -0
  27. ordercloud/models/misc.py +280 -0
  28. ordercloud/models/open_id_connect.py +47 -0
  29. ordercloud/models/order.py +477 -0
  30. ordercloud/models/order_return.py +92 -0
  31. ordercloud/models/payment.py +77 -0
  32. ordercloud/models/price_schedule.py +76 -0
  33. ordercloud/models/product.py +227 -0
  34. ordercloud/models/product_collection.py +186 -0
  35. ordercloud/models/promotion.py +297 -0
  36. ordercloud/models/security.py +89 -0
  37. ordercloud/models/shared.py +131 -0
  38. ordercloud/models/shipment.py +150 -0
  39. ordercloud/models/spec.py +67 -0
  40. ordercloud/models/spending_account.py +33 -0
  41. ordercloud/models/subscription.py +125 -0
  42. ordercloud/models/supplier.py +43 -0
  43. ordercloud/models/sync.py +172 -0
  44. ordercloud/models/user.py +207 -0
  45. ordercloud/models/user_group.py +27 -0
  46. ordercloud/models/webhook.py +58 -0
  47. ordercloud/py.typed +0 -0
  48. ordercloud/resources/__init__.py +65 -0
  49. ordercloud/resources/addresses.py +228 -0
  50. ordercloud/resources/admin_addresses.py +128 -0
  51. ordercloud/resources/admin_user_groups.py +185 -0
  52. ordercloud/resources/admin_users.py +150 -0
  53. ordercloud/resources/api_clients.py +308 -0
  54. ordercloud/resources/approval_rules.py +144 -0
  55. ordercloud/resources/base.py +145 -0
  56. ordercloud/resources/bundle_line_items.py +59 -0
  57. ordercloud/resources/bundle_subscription_items.py +54 -0
  58. ordercloud/resources/bundles.py +278 -0
  59. ordercloud/resources/buyer_groups.py +128 -0
  60. ordercloud/resources/buyers.py +164 -0
  61. ordercloud/resources/cart.py +613 -0
  62. ordercloud/resources/catalogs.py +311 -0
  63. ordercloud/resources/categories.py +392 -0
  64. ordercloud/resources/cost_centers.py +222 -0
  65. ordercloud/resources/credit_cards.py +227 -0
  66. ordercloud/resources/delivery_configurations.py +132 -0
  67. ordercloud/resources/discounts.py +201 -0
  68. ordercloud/resources/entity_syncs.py +534 -0
  69. ordercloud/resources/error_configs.py +71 -0
  70. ordercloud/resources/forgotten_credentials.py +74 -0
  71. ordercloud/resources/group_orders.py +28 -0
  72. ordercloud/resources/impersonation_configs.py +132 -0
  73. ordercloud/resources/incrementors.py +128 -0
  74. ordercloud/resources/integration_events.py +203 -0
  75. ordercloud/resources/inventory_integrations.py +65 -0
  76. ordercloud/resources/inventory_records.py +484 -0
  77. ordercloud/resources/line_items.py +262 -0
  78. ordercloud/resources/locales.py +203 -0
  79. ordercloud/resources/me.py +1882 -0
  80. ordercloud/resources/message_senders.py +261 -0
  81. ordercloud/resources/open_id_connects.py +128 -0
  82. ordercloud/resources/order_returns.py +306 -0
  83. ordercloud/resources/order_syncs.py +65 -0
  84. ordercloud/resources/orders.py +689 -0
  85. ordercloud/resources/payments.py +176 -0
  86. ordercloud/resources/price_schedules.py +164 -0
  87. ordercloud/resources/product_collections.py +116 -0
  88. ordercloud/resources/product_facets.py +128 -0
  89. ordercloud/resources/product_syncs.py +76 -0
  90. ordercloud/resources/products.py +454 -0
  91. ordercloud/resources/promotion_integrations.py +65 -0
  92. ordercloud/resources/promotions.py +203 -0
  93. ordercloud/resources/security_profiles.py +222 -0
  94. ordercloud/resources/seller_approval_rules.py +128 -0
  95. ordercloud/resources/shipments.py +256 -0
  96. ordercloud/resources/specs.py +313 -0
  97. ordercloud/resources/spending_accounts.py +227 -0
  98. ordercloud/resources/subscription_integrations.py +65 -0
  99. ordercloud/resources/subscription_items.py +146 -0
  100. ordercloud/resources/subscriptions.py +128 -0
  101. ordercloud/resources/supplier_addresses.py +144 -0
  102. ordercloud/resources/supplier_user_groups.py +210 -0
  103. ordercloud/resources/supplier_users.py +170 -0
  104. ordercloud/resources/suppliers.py +190 -0
  105. ordercloud/resources/tracking_events.py +130 -0
  106. ordercloud/resources/user_groups.py +210 -0
  107. ordercloud/resources/users.py +254 -0
  108. ordercloud/resources/webhooks.py +128 -0
  109. ordercloud/resources/xp_indices.py +77 -0
  110. ordercloud/sync_client.py +170 -0
  111. ordercloud_python-2026.4.1.dist-info/METADATA +552 -0
  112. ordercloud_python-2026.4.1.dist-info/RECORD +114 -0
  113. ordercloud_python-2026.4.1.dist-info/WHEEL +4 -0
  114. ordercloud_python-2026.4.1.dist-info/licenses/LICENSE +21 -0
@@ -0,0 +1,271 @@
1
+ # GENERATED by tools/codegen — DO NOT EDIT
2
+ # Source: ordercloud-openapi-v3.json
3
+ """OrderCloud BuyerPriceBreak and related models."""
4
+
5
+ from __future__ import annotations
6
+ from typing import Generic, Optional
7
+ from pydantic import Field
8
+
9
+ from .shared import OrderCloudModel, XP
10
+ from .discount import Discount, DiscountedPrices
11
+ from .product import Inventory
12
+
13
+ __all__ = [
14
+ "BuyerPriceBreak",
15
+ "BuyerPriceSchedule",
16
+ "ProductSeller",
17
+ "BuyerAddress",
18
+ "BuyerCreditCard",
19
+ "BuyerProduct",
20
+ "BuyerSupplier",
21
+ "BuyerGroup",
22
+ "Buyer",
23
+ ]
24
+ _Discount = Discount
25
+ _Inventory = Inventory
26
+
27
+
28
+ class BuyerPriceBreak(OrderCloudModel):
29
+ """An OrderCloud BuyerPriceBreak.
30
+
31
+ Attributes:
32
+ discounted: Calculated discounted prices. Only populated when a discount applies to this price break.
33
+ quantity: Most commonly 1, except when offering tiered/bulk pricing.
34
+ price: Price per unit.
35
+ sale_price: Sale Price per unit. If the current date/time is within the PriceSchedule SaleStart and SaleEnd, this SalePrice will be used.
36
+ subscription_price: Subscription Price per unit. If set, this price is used when a subscription order is created.
37
+ bundle_price: Bundle Price per unit. If set, this price is used when an item being added to an order is part of a bundle.
38
+ """
39
+
40
+ discounted: Optional[DiscountedPrices] = Field(None, alias="Discounted")
41
+ quantity: Optional[int] = Field(None, alias="Quantity")
42
+ price: Optional[float] = Field(None, alias="Price")
43
+ sale_price: Optional[float] = Field(None, alias="SalePrice")
44
+ subscription_price: Optional[float] = Field(None, alias="SubscriptionPrice")
45
+ bundle_price: Optional[float] = Field(None, alias="BundlePrice")
46
+
47
+
48
+ class BuyerPriceSchedule(OrderCloudModel, Generic[XP]):
49
+ """An OrderCloud BuyerPriceSchedule.
50
+
51
+ Attributes:
52
+ price_breaks:
53
+ discount: The best applicable discount for this buyer. Only populated when a discount applies.
54
+ owner_id: ID of the organization that owns the PriceSchedule. Only the marketplace owner can override the OwnerID on create.
55
+ id:
56
+ name:
57
+ apply_tax: For reference only for calculating tax, does not influence any OrderCloud behavior.
58
+ apply_shipping: For reference only for calculating shipping cost, does not influence any OrderCloud behavior.
59
+ min_quantity: The minimum line item Quantity when UseCumulativeQuantity is false.
60
+ max_quantity: The maximum line item Quantity when UseCumulativeQuantity is false.
61
+ use_cumulative_quantity: If true, line item quantities will be aggregated by productID when determining which price break applies, and when Min/Max quantities are met. Else, each line item is treated separately.
62
+ restricted_quantity: If true, this product can only be ordered in quantities that exactly match one of the price breaks on this schedule.
63
+ currency: We recommend using ISO-4217 currency codes for compatibility with tax and payment processors.
64
+ sale_start: Starting date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set.
65
+ sale_end: Ending date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set.
66
+ is_on_sale: True when at least one PriceBreak has a SalePrice defined, and the current time is between the SaleStart and SaleEnd date. (read-only)
67
+ xp:
68
+ """
69
+
70
+ price_breaks: Optional[list[BuyerPriceBreak]] = Field(None, alias="PriceBreaks")
71
+ discount: Optional[_Discount] = Field(None, alias="Discount")
72
+ owner_id: Optional[str] = Field(None, alias="OwnerID")
73
+ id: Optional[str] = Field(None, alias="ID")
74
+ name: Optional[str] = Field(None, alias="Name")
75
+ apply_tax: Optional[bool] = Field(None, alias="ApplyTax")
76
+ apply_shipping: Optional[bool] = Field(None, alias="ApplyShipping")
77
+ min_quantity: int = Field(1, alias="MinQuantity")
78
+ max_quantity: Optional[int] = Field(None, alias="MaxQuantity")
79
+ use_cumulative_quantity: Optional[bool] = Field(None, alias="UseCumulativeQuantity")
80
+ restricted_quantity: Optional[bool] = Field(None, alias="RestrictedQuantity")
81
+ currency: Optional[str] = Field(None, alias="Currency")
82
+ sale_start: Optional[str] = Field(None, alias="SaleStart")
83
+ sale_end: Optional[str] = Field(None, alias="SaleEnd")
84
+ is_on_sale: Optional[bool] = Field(None, alias="IsOnSale")
85
+ xp: Optional[XP] = Field(None, alias="xp")
86
+
87
+
88
+ class ProductSeller(OrderCloudModel):
89
+ """An OrderCloud ProductSeller.
90
+
91
+ Attributes:
92
+ price_schedule:
93
+ id:
94
+ name:
95
+ """
96
+
97
+ price_schedule: Optional[BuyerPriceSchedule] = Field(None, alias="PriceSchedule")
98
+ id: Optional[str] = Field(None, alias="ID")
99
+ name: Optional[str] = Field(None, alias="Name")
100
+
101
+
102
+ class BuyerAddress(OrderCloudModel, Generic[XP]):
103
+ """An OrderCloud BuyerAddress.
104
+
105
+ Attributes:
106
+ id: (read-only)
107
+ shipping: Indicates whether this address can be used as a ShippingAddress on an order or line item.
108
+ billing: Indicates whether this address can be used as a BillingAddress on an order.
109
+ editable: Indicates whether this address can be edited by the current user. (read-only)
110
+ date_created: (read-only)
111
+ company_name:
112
+ first_name:
113
+ last_name:
114
+ street1:
115
+ street2:
116
+ city:
117
+ state:
118
+ zip:
119
+ country:
120
+ phone:
121
+ address_name:
122
+ xp:
123
+ """
124
+
125
+ id: Optional[str] = Field(None, alias="ID")
126
+ shipping: Optional[bool] = Field(None, alias="Shipping")
127
+ billing: Optional[bool] = Field(None, alias="Billing")
128
+ editable: Optional[bool] = Field(None, alias="Editable")
129
+ date_created: Optional[str] = Field(None, alias="DateCreated")
130
+ company_name: Optional[str] = Field(None, alias="CompanyName")
131
+ first_name: Optional[str] = Field(None, alias="FirstName")
132
+ last_name: Optional[str] = Field(None, alias="LastName")
133
+ street1: Optional[str] = Field(None, alias="Street1")
134
+ street2: Optional[str] = Field(None, alias="Street2")
135
+ city: Optional[str] = Field(None, alias="City")
136
+ state: Optional[str] = Field(None, alias="State")
137
+ zip: Optional[str] = Field(None, alias="Zip")
138
+ country: Optional[str] = Field(None, alias="Country")
139
+ phone: Optional[str] = Field(None, alias="Phone")
140
+ address_name: Optional[str] = Field(None, alias="AddressName")
141
+ xp: Optional[XP] = Field(None, alias="xp")
142
+
143
+
144
+ class BuyerCreditCard(OrderCloudModel, Generic[XP]):
145
+ """An OrderCloud BuyerCreditCard.
146
+
147
+ Attributes:
148
+ id: (read-only)
149
+ editable: (read-only)
150
+ token: Token provided by the credit card processor used to reference the card with that processor.
151
+ date_created: (read-only)
152
+ card_type:
153
+ partial_account_number:
154
+ cardholder_name:
155
+ expiration_date:
156
+ xp:
157
+ """
158
+
159
+ id: Optional[str] = Field(None, alias="ID")
160
+ editable: Optional[bool] = Field(None, alias="Editable")
161
+ token: Optional[str] = Field(None, alias="Token")
162
+ date_created: Optional[str] = Field(None, alias="DateCreated")
163
+ card_type: Optional[str] = Field(None, alias="CardType")
164
+ partial_account_number: Optional[str] = Field(None, alias="PartialAccountNumber")
165
+ cardholder_name: Optional[str] = Field(None, alias="CardholderName")
166
+ expiration_date: Optional[str] = Field(None, alias="ExpirationDate")
167
+ xp: Optional[XP] = Field(None, alias="xp")
168
+
169
+
170
+ class BuyerProduct(OrderCloudModel, Generic[XP]):
171
+ """An OrderCloud BuyerProduct.
172
+
173
+ Attributes:
174
+ price_schedule: (read-only)
175
+ id:
176
+ parent_id: ID of the parent product. If not null, IsParent should be false
177
+ is_parent: If true, ParentID must be null, as a parent product cannot have a parent itself.
178
+ is_bundle: If true, IsParent must be false, as a parent product cannot be a bundle. (read-only)
179
+ name:
180
+ description:
181
+ quantity_multiplier: For reference only, does not influence any OrderCloud behavior. Used to indicate an amount per Quantity.
182
+ ship_weight:
183
+ ship_height:
184
+ ship_width:
185
+ ship_length:
186
+ active: If false, product is not visible or purchasable from a buyer's perspective.
187
+ spec_count: Count of specs assigned to the product. (read-only)
188
+ variant_count: Count of variants generated from the product/spec combinations. (read-only)
189
+ ship_from_address_id: Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs.
190
+ inventory:
191
+ default_supplier_id: Used for forwarding orders to suppliers.
192
+ all_suppliers_can_sell: If true, all suppliers are eligible to opt into selling this product.
193
+ returnable:
194
+ date_created: (read-only)
195
+ xp:
196
+ """
197
+
198
+ price_schedule: Optional[BuyerPriceSchedule] = Field(None, alias="PriceSchedule")
199
+ id: Optional[str] = Field(None, alias="ID")
200
+ parent_id: Optional[str] = Field(None, alias="ParentID")
201
+ is_parent: Optional[bool] = Field(None, alias="IsParent")
202
+ is_bundle: Optional[bool] = Field(None, alias="IsBundle")
203
+ name: Optional[str] = Field(None, alias="Name")
204
+ description: Optional[str] = Field(None, alias="Description")
205
+ quantity_multiplier: int = Field(1, alias="QuantityMultiplier")
206
+ ship_weight: Optional[float] = Field(None, alias="ShipWeight")
207
+ ship_height: Optional[float] = Field(None, alias="ShipHeight")
208
+ ship_width: Optional[float] = Field(None, alias="ShipWidth")
209
+ ship_length: Optional[float] = Field(None, alias="ShipLength")
210
+ active: Optional[bool] = Field(None, alias="Active")
211
+ spec_count: int = Field(0, alias="SpecCount")
212
+ variant_count: int = Field(0, alias="VariantCount")
213
+ ship_from_address_id: Optional[str] = Field(None, alias="ShipFromAddressID")
214
+ inventory: Optional[_Inventory] = Field(None, alias="Inventory")
215
+ default_supplier_id: Optional[str] = Field(None, alias="DefaultSupplierID")
216
+ all_suppliers_can_sell: Optional[bool] = Field(None, alias="AllSuppliersCanSell")
217
+ returnable: Optional[bool] = Field(None, alias="Returnable")
218
+ date_created: Optional[str] = Field(None, alias="DateCreated")
219
+ xp: Optional[XP] = Field(None, alias="xp")
220
+
221
+
222
+ class BuyerSupplier(OrderCloudModel):
223
+ """An OrderCloud BuyerSupplier.
224
+
225
+ Attributes:
226
+ id:
227
+ name:
228
+ """
229
+
230
+ id: Optional[str] = Field(None, alias="ID")
231
+ name: Optional[str] = Field(None, alias="Name")
232
+
233
+
234
+ class BuyerGroup(OrderCloudModel, Generic[XP]):
235
+ """An OrderCloud BuyerGroup.
236
+
237
+ Attributes:
238
+ id:
239
+ name:
240
+ description:
241
+ default_catalog_id: If null at the individual buyer level, and buyer is a member of this group, buyer inherits this default catalog.
242
+ xp:
243
+ """
244
+
245
+ id: Optional[str] = Field(None, alias="ID")
246
+ name: Optional[str] = Field(None, alias="Name")
247
+ description: Optional[str] = Field(None, alias="Description")
248
+ default_catalog_id: Optional[str] = Field(None, alias="DefaultCatalogID")
249
+ xp: Optional[XP] = Field(None, alias="xp")
250
+
251
+
252
+ class Buyer(OrderCloudModel, Generic[XP]):
253
+ """An OrderCloud Buyer.
254
+
255
+ Attributes:
256
+ id:
257
+ name:
258
+ group_id:
259
+ default_catalog_id: Allows filtering products by category without explicitly providing a CatalogID. Inherits from buyer group if not specified. If neither is specified when buyer is created, a new catalog is automatically created.
260
+ active: If false, all user authentication is blocked.
261
+ date_created: (read-only)
262
+ xp:
263
+ """
264
+
265
+ id: Optional[str] = Field(None, alias="ID")
266
+ name: Optional[str] = Field(None, alias="Name")
267
+ group_id: Optional[str] = Field(None, alias="GroupID")
268
+ default_catalog_id: Optional[str] = Field(None, alias="DefaultCatalogID")
269
+ active: Optional[bool] = Field(None, alias="Active")
270
+ date_created: Optional[str] = Field(None, alias="DateCreated")
271
+ xp: Optional[XP] = Field(None, alias="xp")
@@ -0,0 +1,33 @@
1
+ # GENERATED by tools/codegen — DO NOT EDIT
2
+ # Source: ordercloud-openapi-v3.json
3
+ """OrderCloud Catalog models."""
4
+
5
+ from __future__ import annotations
6
+ from typing import Generic, Optional
7
+ from pydantic import Field
8
+
9
+ from .shared import OrderCloudModel, XP
10
+
11
+ __all__ = ["Catalog"]
12
+
13
+
14
+ class Catalog(OrderCloudModel, Generic[XP]):
15
+ """An OrderCloud Catalog.
16
+
17
+ Attributes:
18
+ id:
19
+ owner_id: ID of the organization that owns the catalog. Only the marketplace owner can override the OwnerID on create.
20
+ name:
21
+ description:
22
+ active: Categories and products within to this catalog will not be visible to buyer users if false.
23
+ category_count: (read-only)
24
+ xp:
25
+ """
26
+
27
+ id: Optional[str] = Field(None, alias="ID")
28
+ owner_id: Optional[str] = Field(None, alias="OwnerID")
29
+ name: Optional[str] = Field(None, alias="Name")
30
+ description: Optional[str] = Field(None, alias="Description")
31
+ active: Optional[bool] = Field(None, alias="Active")
32
+ category_count: int = Field(0, alias="CategoryCount")
33
+ xp: Optional[XP] = Field(None, alias="xp")
@@ -0,0 +1,35 @@
1
+ # GENERATED by tools/codegen — DO NOT EDIT
2
+ # Source: ordercloud-openapi-v3.json
3
+ """OrderCloud Category models."""
4
+
5
+ from __future__ import annotations
6
+ from typing import Generic, Optional
7
+ from pydantic import Field
8
+
9
+ from .shared import OrderCloudModel, XP
10
+
11
+ __all__ = ["Category"]
12
+
13
+
14
+ class Category(OrderCloudModel, Generic[XP]):
15
+ """An OrderCloud Category.
16
+
17
+ Attributes:
18
+ id:
19
+ name:
20
+ description:
21
+ list_order: Order that the category appears within its parent or catalog (if root level).
22
+ active: If false, buyers cannot see this category or any categories or products under it.
23
+ parent_id: ID of the parent category.
24
+ child_count: Number of categories that are *immediate* children of this category. (read-only)
25
+ xp:
26
+ """
27
+
28
+ id: Optional[str] = Field(None, alias="ID")
29
+ name: Optional[str] = Field(None, alias="Name")
30
+ description: Optional[str] = Field(None, alias="Description")
31
+ list_order: Optional[int] = Field(None, alias="ListOrder")
32
+ active: Optional[bool] = Field(None, alias="Active")
33
+ parent_id: Optional[str] = Field(None, alias="ParentID")
34
+ child_count: int = Field(0, alias="ChildCount")
35
+ xp: Optional[XP] = Field(None, alias="xp")
@@ -0,0 +1,27 @@
1
+ # GENERATED by tools/codegen — DO NOT EDIT
2
+ # Source: ordercloud-openapi-v3.json
3
+ """OrderCloud CostCenter models."""
4
+
5
+ from __future__ import annotations
6
+ from typing import Generic, Optional
7
+ from pydantic import Field
8
+
9
+ from .shared import OrderCloudModel, XP
10
+
11
+ __all__ = ["CostCenter"]
12
+
13
+
14
+ class CostCenter(OrderCloudModel, Generic[XP]):
15
+ """An OrderCloud CostCenter.
16
+
17
+ Attributes:
18
+ id:
19
+ name:
20
+ description:
21
+ xp:
22
+ """
23
+
24
+ id: Optional[str] = Field(None, alias="ID")
25
+ name: Optional[str] = Field(None, alias="Name")
26
+ description: Optional[str] = Field(None, alias="Description")
27
+ xp: Optional[XP] = Field(None, alias="xp")
@@ -0,0 +1,35 @@
1
+ # GENERATED by tools/codegen — DO NOT EDIT
2
+ # Source: ordercloud-openapi-v3.json
3
+ """OrderCloud CreditCard models."""
4
+
5
+ from __future__ import annotations
6
+ from typing import Generic, Optional
7
+ from pydantic import Field
8
+
9
+ from .shared import OrderCloudModel, XP
10
+
11
+ __all__ = ["CreditCard"]
12
+
13
+
14
+ class CreditCard(OrderCloudModel, Generic[XP]):
15
+ """An OrderCloud CreditCard.
16
+
17
+ Attributes:
18
+ id:
19
+ token: Token provided by the credit card processor used to reference the card with that processor.
20
+ date_created: (read-only)
21
+ card_type:
22
+ partial_account_number:
23
+ cardholder_name:
24
+ expiration_date:
25
+ xp:
26
+ """
27
+
28
+ id: Optional[str] = Field(None, alias="ID")
29
+ token: Optional[str] = Field(None, alias="Token")
30
+ date_created: Optional[str] = Field(None, alias="DateCreated")
31
+ card_type: Optional[str] = Field(None, alias="CardType")
32
+ partial_account_number: Optional[str] = Field(None, alias="PartialAccountNumber")
33
+ cardholder_name: Optional[str] = Field(None, alias="CardholderName")
34
+ expiration_date: Optional[str] = Field(None, alias="ExpirationDate")
35
+ xp: Optional[XP] = Field(None, alias="xp")
@@ -0,0 +1,277 @@
1
+ # GENERATED by tools/codegen — DO NOT EDIT
2
+ # Source: ordercloud-openapi-v3.json
3
+ """OrderCloud KafkaConfig and related models."""
4
+
5
+ from __future__ import annotations
6
+ from typing import Any, Optional
7
+ from pydantic import Field
8
+
9
+ from .shared import OrderCloudModel
10
+ from .message_sender import MessageSenderConfig
11
+
12
+ __all__ = [
13
+ "KafkaConfig",
14
+ "HttpConfig",
15
+ "EventHubConfig",
16
+ "AzureBlobConfig",
17
+ "AzureTableConfig",
18
+ "CosmosDbConfig",
19
+ "MailchimpConfig",
20
+ "ContentHubConfig",
21
+ "SearchIngestionContent",
22
+ "SearchIngestionHttpContent",
23
+ "SearchIngestion",
24
+ "DeliveryTargets",
25
+ "DeliveryConfig",
26
+ "SendEvent",
27
+ "DiscoverEvent",
28
+ "ErrorConfig",
29
+ ]
30
+
31
+
32
+ class KafkaConfig(OrderCloudModel):
33
+ """An OrderCloud KafkaConfig.
34
+
35
+ Attributes:
36
+ bootstrap_servers:
37
+ sasl_username:
38
+ sasl_password:
39
+ topic:
40
+ """
41
+
42
+ bootstrap_servers: Optional[str] = Field(None, alias="BootstrapServers")
43
+ sasl_username: Optional[str] = Field(None, alias="SaslUsername")
44
+ sasl_password: Optional[str] = Field(None, alias="SaslPassword")
45
+ topic: Optional[str] = Field(None, alias="Topic")
46
+
47
+
48
+ class HttpConfig(OrderCloudModel):
49
+ """An OrderCloud HttpConfig.
50
+
51
+ Attributes:
52
+ endpoint:
53
+ secret:
54
+ custom_auth_header_name:
55
+ custom_auth_header_value:
56
+ """
57
+
58
+ endpoint: Optional[str] = Field(None, alias="Endpoint")
59
+ secret: Optional[str] = Field(None, alias="Secret")
60
+ custom_auth_header_name: Optional[str] = Field(None, alias="CustomAuthHeaderName")
61
+ custom_auth_header_value: Optional[str] = Field(None, alias="CustomAuthHeaderValue")
62
+
63
+
64
+ class EventHubConfig(OrderCloudModel):
65
+ """An OrderCloud EventHubConfig.
66
+
67
+ Attributes:
68
+ event_hub_name:
69
+ connection_string:
70
+ """
71
+
72
+ event_hub_name: Optional[str] = Field(None, alias="EventHubName")
73
+ connection_string: Optional[str] = Field(None, alias="ConnectionString")
74
+
75
+
76
+ class AzureBlobConfig(OrderCloudModel):
77
+ """An OrderCloud AzureBlobConfig.
78
+
79
+ Attributes:
80
+ connection_string: Storage account connection string.
81
+ override_container_name:
82
+ """
83
+
84
+ connection_string: Optional[str] = Field(None, alias="ConnectionString")
85
+ override_container_name: Optional[str] = Field(None, alias="OverrideContainerName")
86
+
87
+
88
+ class AzureTableConfig(OrderCloudModel):
89
+ """An OrderCloud AzureTableConfig.
90
+
91
+ Attributes:
92
+ connection_string: Storage account connection string.
93
+ override_table_name:
94
+ """
95
+
96
+ connection_string: Optional[str] = Field(None, alias="ConnectionString")
97
+ override_table_name: Optional[str] = Field(None, alias="OverrideTableName")
98
+
99
+
100
+ class CosmosDbConfig(OrderCloudModel):
101
+ """An OrderCloud CosmosDbConfig.
102
+
103
+ Attributes:
104
+ connection_string: Storage account connection string.
105
+ override_database_name:
106
+ """
107
+
108
+ connection_string: Optional[str] = Field(None, alias="ConnectionString")
109
+ override_database_name: Optional[str] = Field(None, alias="OverrideDatabaseName")
110
+
111
+
112
+ class MailchimpConfig(OrderCloudModel):
113
+ """An OrderCloud MailchimpConfig.
114
+
115
+ Attributes:
116
+ api_key: The Mailchimp API key. If this property is not set, the default OrderCloud Mailchimp instance is used. The default instance is intended for test purposes only.
117
+ """
118
+
119
+ api_key: Optional[str] = Field(None, alias="ApiKey")
120
+
121
+
122
+ class ContentHubConfig(OrderCloudModel):
123
+ """An OrderCloud ContentHubConfig.
124
+
125
+ Attributes:
126
+ api_key:
127
+ endpoint:
128
+ target_schema_name:
129
+ config_data: Any custom property mapping should be included here.
130
+ """
131
+
132
+ api_key: Optional[str] = Field(None, alias="ApiKey")
133
+ endpoint: Optional[str] = Field(None, alias="Endpoint")
134
+ target_schema_name: Optional[str] = Field(None, alias="TargetSchemaName")
135
+ config_data: Optional[dict[str, Any]] = Field(None, alias="ConfigData")
136
+
137
+
138
+ class SearchIngestionContent(OrderCloudModel):
139
+ """An OrderCloud SearchIngestionContent.
140
+
141
+ Attributes:
142
+ locales: Supported search ingestion locales.
143
+ http:
144
+ """
145
+
146
+ locales: Optional[list[str]] = Field(None, alias="Locales")
147
+ http: Optional[SearchIngestionHttpContent] = Field(None, alias="Http")
148
+
149
+
150
+ class SearchIngestionHttpContent(OrderCloudModel):
151
+ """An OrderCloud SearchIngestionHttpContent.
152
+
153
+ Attributes:
154
+ endpoint:
155
+ custom_auth_header_name: Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data.
156
+ custom_auth_header_value: The header value that can be passed to your middleware.
157
+ """
158
+
159
+ endpoint: Optional[str] = Field(None, alias="Endpoint")
160
+ custom_auth_header_name: Optional[str] = Field(None, alias="CustomAuthHeaderName")
161
+ custom_auth_header_value: Optional[str] = Field(None, alias="CustomAuthHeaderValue")
162
+
163
+
164
+ class SearchIngestion(OrderCloudModel):
165
+ """An OrderCloud SearchIngestion.
166
+
167
+ Attributes:
168
+ domain:
169
+ source:
170
+ endpoint:
171
+ entity:
172
+ api_key:
173
+ content:
174
+ """
175
+
176
+ domain: Optional[str] = Field(None, alias="Domain")
177
+ source: Optional[str] = Field(None, alias="Source")
178
+ endpoint: Optional[str] = Field(None, alias="Endpoint")
179
+ entity: Optional[str] = Field(None, alias="Entity")
180
+ api_key: Optional[str] = Field(None, alias="ApiKey")
181
+ content: Optional[SearchIngestionContent] = Field(None, alias="Content")
182
+
183
+
184
+ class DeliveryTargets(OrderCloudModel):
185
+ """An OrderCloud DeliveryTargets.
186
+
187
+ Attributes:
188
+ kafka:
189
+ http:
190
+ search_ingestion:
191
+ send_event:
192
+ discover_event:
193
+ event_hub:
194
+ azure_blob:
195
+ azure_table:
196
+ cosmos_db:
197
+ mailchimp:
198
+ message_sender:
199
+ content_hub:
200
+ """
201
+
202
+ kafka: Optional[KafkaConfig] = Field(None, alias="Kafka")
203
+ http: Optional[HttpConfig] = Field(None, alias="Http")
204
+ search_ingestion: Optional[_SearchIngestion] = Field(None, alias="SearchIngestion")
205
+ send_event: Optional[_SendEvent] = Field(None, alias="SendEvent")
206
+ discover_event: Optional[_DiscoverEvent] = Field(None, alias="DiscoverEvent")
207
+ event_hub: Optional[EventHubConfig] = Field(None, alias="EventHub")
208
+ azure_blob: Optional[AzureBlobConfig] = Field(None, alias="AzureBlob")
209
+ azure_table: Optional[AzureTableConfig] = Field(None, alias="AzureTable")
210
+ cosmos_db: Optional[CosmosDbConfig] = Field(None, alias="CosmosDb")
211
+ mailchimp: Optional[MailchimpConfig] = Field(None, alias="Mailchimp")
212
+ message_sender: Optional[MessageSenderConfig] = Field(None, alias="MessageSender")
213
+ content_hub: Optional[ContentHubConfig] = Field(None, alias="ContentHub")
214
+
215
+
216
+ class DeliveryConfig(OrderCloudModel):
217
+ """An OrderCloud DeliveryConfig.
218
+
219
+ Attributes:
220
+ id:
221
+ name:
222
+ enabled:
223
+ delivery_targets:
224
+ """
225
+
226
+ id: Optional[str] = Field(None, alias="ID")
227
+ name: Optional[str] = Field(None, alias="Name")
228
+ enabled: Optional[bool] = Field(None, alias="Enabled")
229
+ delivery_targets: Optional[_DeliveryTargets] = Field(None, alias="DeliveryTargets")
230
+
231
+
232
+ class SendEvent(OrderCloudModel):
233
+ """An OrderCloud SendEvent.
234
+
235
+ Attributes:
236
+ site_id:
237
+ service_endpoint:
238
+ """
239
+
240
+ site_id: Optional[str] = Field(None, alias="SiteID")
241
+ service_endpoint: Optional[str] = Field(None, alias="ServiceEndpoint")
242
+
243
+
244
+ class DiscoverEvent(OrderCloudModel):
245
+ """An OrderCloud DiscoverEvent.
246
+
247
+ Attributes:
248
+ client_id:
249
+ api_key:
250
+ service_endpoint:
251
+ """
252
+
253
+ client_id: Optional[str] = Field(None, alias="ClientID")
254
+ api_key: Optional[str] = Field(None, alias="ApiKey")
255
+ service_endpoint: Optional[str] = Field(None, alias="ServiceEndpoint")
256
+
257
+
258
+ class ErrorConfig(OrderCloudModel):
259
+ """An OrderCloud ErrorConfig.
260
+
261
+ Attributes:
262
+ delivery_config_id:
263
+ """
264
+
265
+ delivery_config_id: Optional[str] = Field(None, alias="DeliveryConfigID")
266
+
267
+
268
+ _SearchIngestion = SearchIngestion
269
+
270
+
271
+ _SendEvent = SendEvent
272
+
273
+
274
+ _DiscoverEvent = DiscoverEvent
275
+
276
+
277
+ _DeliveryTargets = DeliveryTargets