feat(api): updates

api.md

@@ -1,3 +1,9 @@
+# Shared Types
+
+```python
+from orb.types import Discount
+```
+
 # TopLevel
 
 Types:
@@ -196,7 +202,7 @@ Methods:
 Types:
 
 ```python
-from orb.types import Invoice, InvoiceDiscount, InvoiceFetchUpcomingResponse
+from orb.types import Invoice, InvoiceFetchUpcomingResponse
 ```
 
 Methods:
@@ -263,7 +269,7 @@ Methods:
 Types:
 
 ```python
-from orb.types import Discount, Price
+from orb.types import Price
 ```
 
 Methods:
@@ -285,8 +291,8 @@ Types:
 ```python
 from orb.types import (
     Subscription,
-    Subscriptions,
     SubscriptionUsage,
+    Subscriptions,
     SubscriptionFetchCostsResponse,
     SubscriptionFetchScheduleResponse,
 )

src/orb/resources/coupons/coupons.py

@@ -28,7 +28,7 @@ def __init__(self, client: Orb) -> None:
     def create(
         self,
         *,
-        discount: object,
+        discount: coupon_create_params.Discount,
         redemption_code: str,
         duration_in_months: Optional[int] | NotGiven = NOT_GIVEN,
         max_redemptions: Optional[int] | NotGiven = NOT_GIVEN,
@@ -232,7 +232,7 @@ def __init__(self, client: AsyncOrb) -> None:
     async def create(
         self,
         *,
-        discount: object,
+        discount: coupon_create_params.Discount,
         redemption_code: str,
         duration_in_months: Optional[int] | NotGiven = NOT_GIVEN,
         max_redemptions: Optional[int] | NotGiven = NOT_GIVEN,

src/orb/resources/events/events.py

@@ -246,47 +246,47 @@ def ingest(
         Events are the starting point for all usage calculations in the system, and are
         simple at their core:
 
-        ```json
+        ```ts
         {
-        // customer_id and external_customer_id are used to
-        // attribute usage to a given Customer. Exactly one of these
-        // should be specified in a given ingestion event.
-
-        // `customer_id` is the Orb generated identifier for the Customer,
-        // which is returned from the Create customer API call.
-        customer_id: string,
-
-        // external_customer_id is an alternate identifier which is associated
-        // with a Customer at creation time. This is treated as an alias for
-        // customer_id, and is usually set to an identifier native to your system.
-        external_customer_id: string,
-
-        // A string name identifying the event, usually a usage
-        // action. By convention, this should not contain any whitespace.
-        event_name: string,
-
-        // An ISO 8601 format date with no timezone offset.
-        // This should represent the time that usage occurred
-        // and is important to attribute usage to a given
-        // billing period. See the notes below on determining the timestamp.
-        // e.g. 2020-12-09T16:09:53Z
-        timestamp: string,
-
-        // A unique value, generated by the client, that is
-        // used to de-duplicate events.
-        // Exactly one event with a given
-        // idempotency key will be ingested, which allows for
-        // safe request retries.
-        idempotency_key: string
-
-        // Optional custom metadata to attach to the event.
-        // This might include a numeric value used for aggregation,
-        // or a string/boolean value used for filtering.
-        // The schema of this dictionary need not be pre-declared, and
-        // properties can be added at any time.
-        properties: {
-        [key: string]?: string | number | boolean,
-        },
+          // customer_id and external_customer_id are used to
+          // attribute usage to a given Customer. Exactly one of these
+          // should be specified in a given ingestion event.
+
+          // `customer_id` is the Orb generated identifier for the Customer,
+          // which is returned from the Create customer API call.
+          customer_id: string,
+
+          // external_customer_id is an alternate identifier which is associated
+          // with a Customer at creation time. This is treated as an alias for
+          // customer_id, and is usually set to an identifier native to your system.
+          external_customer_id: string,
+
+          // A string name identifying the event, usually a usage
+          // action. By convention, this should not contain any whitespace.
+          event_name: string,
+
+          // An ISO 8601 format date with no timezone offset.
+          // This should represent the time that usage occurred
+          // and is important to attribute usage to a given
+          // billing period. See the notes below on determining the timestamp.
+          // e.g. 2020-12-09T16:09:53Z
+          timestamp: string,
+
+          // A unique value, generated by the client, that is
+          // used to de-duplicate events.
+          // Exactly one event with a given
+          // idempotency key will be ingested, which allows for
+          // safe request retries.
+          idempotency_key: string
+
+          // Optional custom metadata to attach to the event.
+          // This might include a numeric value used for aggregation,
+          // or a string/boolean value used for filtering.
+          // The schema of this dictionary need not be pre-declared, and
+          // properties can be added at any time.
+          properties: {
+            [key: string]?: string | number | boolean,
+          },
         }
         ```
 
@@ -785,47 +785,47 @@ async def ingest(
         Events are the starting point for all usage calculations in the system, and are
         simple at their core:
 
-        ```json
+        ```ts
         {
-        // customer_id and external_customer_id are used to
-        // attribute usage to a given Customer. Exactly one of these
-        // should be specified in a given ingestion event.
-
-        // `customer_id` is the Orb generated identifier for the Customer,
-        // which is returned from the Create customer API call.
-        customer_id: string,
-
-        // external_customer_id is an alternate identifier which is associated
-        // with a Customer at creation time. This is treated as an alias for
-        // customer_id, and is usually set to an identifier native to your system.
-        external_customer_id: string,
-
-        // A string name identifying the event, usually a usage
-        // action. By convention, this should not contain any whitespace.
-        event_name: string,
-
-        // An ISO 8601 format date with no timezone offset.
-        // This should represent the time that usage occurred
-        // and is important to attribute usage to a given
-        // billing period. See the notes below on determining the timestamp.
-        // e.g. 2020-12-09T16:09:53Z
-        timestamp: string,
-
-        // A unique value, generated by the client, that is
-        // used to de-duplicate events.
-        // Exactly one event with a given
-        // idempotency key will be ingested, which allows for
-        // safe request retries.
-        idempotency_key: string
-
-        // Optional custom metadata to attach to the event.
-        // This might include a numeric value used for aggregation,
-        // or a string/boolean value used for filtering.
-        // The schema of this dictionary need not be pre-declared, and
-        // properties can be added at any time.
-        properties: {
-        [key: string]?: string | number | boolean,
-        },
+          // customer_id and external_customer_id are used to
+          // attribute usage to a given Customer. Exactly one of these
+          // should be specified in a given ingestion event.
+
+          // `customer_id` is the Orb generated identifier for the Customer,
+          // which is returned from the Create customer API call.
+          customer_id: string,
+
+          // external_customer_id is an alternate identifier which is associated
+          // with a Customer at creation time. This is treated as an alias for
+          // customer_id, and is usually set to an identifier native to your system.
+          external_customer_id: string,
+
+          // A string name identifying the event, usually a usage
+          // action. By convention, this should not contain any whitespace.
+          event_name: string,
+
+          // An ISO 8601 format date with no timezone offset.
+          // This should represent the time that usage occurred
+          // and is important to attribute usage to a given
+          // billing period. See the notes below on determining the timestamp.
+          // e.g. 2020-12-09T16:09:53Z
+          timestamp: string,
+
+          // A unique value, generated by the client, that is
+          // used to de-duplicate events.
+          // Exactly one event with a given
+          // idempotency key will be ingested, which allows for
+          // safe request retries.
+          idempotency_key: string
+
+          // Optional custom metadata to attach to the event.
+          // This might include a numeric value used for aggregation,
+          // or a string/boolean value used for filtering.
+          // The schema of this dictionary need not be pre-declared, and
+          // properties can be added at any time.
+          properties: {
+            [key: string]?: string | number | boolean,
+          },
         }
         ```
 

src/orb/resources/invoices.py

@@ -124,7 +124,7 @@ def list(
         invoice_date_lte: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
         is_recurring: Optional[bool] | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
-        status: Optional[Literal["draft", "issued", "paid", "synced", "void"]] | NotGiven = NOT_GIVEN,
+        status: Optional[List[Literal["draft", "issued", "paid", "synced", "void"]]] | NotGiven = NOT_GIVEN,
         subscription_id: Optional[str] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -513,7 +513,7 @@ def list(
         invoice_date_lte: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
         is_recurring: Optional[bool] | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
-        status: Optional[Literal["draft", "issued", "paid", "synced", "void"]] | NotGiven = NOT_GIVEN,
+        status: Optional[List[Literal["draft", "issued", "paid", "synced", "void"]]] | NotGiven = NOT_GIVEN,
         subscription_id: Optional[str] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.

src/orb/resources/plans/plans.py

@@ -32,7 +32,7 @@ def create(
         *,
         currency: str,
         name: str,
-        prices: List[object],
+        prices: List[plan_create_params.Price],
         default_invoice_memo: Optional[str] | NotGiven = NOT_GIVEN,
         external_plan_id: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Optional[object] | NotGiven = NOT_GIVEN,
@@ -273,7 +273,7 @@ async def create(
         *,
         currency: str,
         name: str,
-        prices: List[object],
+        prices: List[plan_create_params.Price],
         default_invoice_memo: Optional[str] | NotGiven = NOT_GIVEN,
         external_plan_id: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Optional[object] | NotGiven = NOT_GIVEN,