Merge pull request #19 from speakeasy-sdks/speakeasy-sdk-regen-1685629591

chore: speakeasy sdk regeneration - Generate

Author: ndimares

.gitignore

@@ -0,0 +1,5 @@
+venv/
+src/*.egg-info/
+__pycache__/
+.pytest_cache/
+.python-version`

README.md

@@ -31,7 +31,7 @@ s = orb.Orb(
 
 res = s.availability.ping()
 
-if res.ping_200_application_json_object is not None:
+if res.availability is not None:
     # handle response
 ```
 <!-- End SDK Example Usage -->

RELEASES.md

@@ -202,4 +202,12 @@ Based on:
 - OpenAPI Doc 1.0 ./openapi/openapi.yaml
 - Speakeasy CLI 1.39.0 (2.32.7) https://github.com/speakeasy-api/speakeasy
 ### Releases
-- [PyPI v0.11.0] https://pypi.org/project/orb-billing/0.11.0 - .
+- [PyPI v0.11.0] https://pypi.org/project/orb-billing/0.11.0 - .
+
+## 2023-06-01 14:26:29
+### Changes
+Based on:
+- OpenAPI Doc 1.0 ./openapi/openapi.yaml
+- Speakeasy CLI 1.40.3 (2.34.7) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.12.0] https://pypi.org/project/orb-billing/0.12.0 - .

USAGE.md

@@ -12,7 +12,7 @@ s = orb.Orb(
 
 res = s.availability.ping()
 
-if res.ping_200_application_json_object is not None:
+if res.availability is not None:
     # handle response
 ```
 <!-- End SDK Example Usage -->

docs/availability/README.md

@@ -29,6 +29,6 @@ s = orb.Orb(
 
 res = s.availability.ping()
 
-if res.ping_200_application_json_object is not None:
+if res.availability is not None:
     # handle response
 ```

docs/coupon/README.md

@@ -102,9 +102,9 @@ if res.coupon is not None:
 
 ## list
 
-This endpoint returns a list of all [coupons](../reference/Orb-API.json/components/schemas/Coupon) for an account in a list format. 
+This endpoint returns a list of all coupons for an account in a list format. 
 
-The list of coupons is ordered starting from the most recently created coupon. The response also includes [`pagination_metadata`](../api/pagination), which lets the caller retrieve the next page of results if they exist. More information about pagination can be found in the [Pagination-metadata schema](../reference/Orb-API.json/components/schemas/Pagination-metadata).
+The list of coupons is ordered starting from the most recently created coupon. The response also includes [`pagination_metadata`](../api/pagination), which lets the caller retrieve the next page of results if they exist. More information about pagination can be found in the [Pagination-metadata schema](pagination).
 
 ### Example Usage
 
@@ -127,7 +127,7 @@ if res.list_coupons_200_application_json_object is not None:
 
 ## list_subscriptions
 
-This endpoint returns a list of all subscriptions that have redeemed a given coupon as a [paginated](../api/pagination) list, ordered starting from the most recently created subscription. For a full discussion of the subscription resource, see [Subscription](../reference/Orb-API.json/components/schemas/Subscription).
+This endpoint returns a list of all subscriptions that have redeemed a given coupon as a [paginated](../api/pagination) list, ordered starting from the most recently created subscription. For a full discussion of the subscription resource, see [Subscription](../guides/concepts#subscription).
 
 ### Example Usage
 

docs/credit/README.md

@@ -22,7 +22,7 @@ This endpoint's resource and semantics exactly mirror [Add credit ledger entry](
 ```python
 import orb
 import dateutil.parser
-from orb.models import operations
+from orb.models import operations, shared
 
 s = orb.Orb(
     security=shared.Security(
@@ -31,13 +31,13 @@ s = orb.Orb(
 )
 
 
-res = s.credit.add_by_external_id('porro', operations.AddLedgerEntryExternalIDRequestBody(
+res = s.credit.add_by_external_id('porro', shared.NewCreditLedgerEntry(
     amount=6788.8,
     block_id='dicta',
     description='nam',
-    entry_type=operations.AddLedgerEntryExternalIDRequestBodyEntryType.DECREMENT,
+    entry_type=shared.NewCreditLedgerEntryEntryType.DECREMENT,
     expiry_date=dateutil.parser.parse('2023-01-01').date(),
-    invoice_settings=operations.AddLedgerEntryExternalIDRequestBodyInvoiceSettings(
+    invoice_settings=shared.NewCreditLedgerEntryInvoiceSettings(
         auto_collection=False,
         memo='occaecati',
         net_terms=1433.53,
@@ -120,7 +120,7 @@ The following snippet illustrates a sample request body to extend the expiration
 ```python
 import orb
 import dateutil.parser
-from orb.models import operations
+from orb.models import operations, shared
 
 s = orb.Orb(
     security=shared.Security(
@@ -129,13 +129,13 @@ s = orb.Orb(
 )
 
 
-res = s.credit.create('qui', operations.CreateLedgerEntryRequestBody(
+res = s.credit.create('qui', shared.NewCreditLedgerEntry(
     amount=7742.34,
     block_id='cum',
     description='esse',
-    entry_type=operations.CreateLedgerEntryRequestBodyEntryType.INCREMENT,
+    entry_type=shared.NewCreditLedgerEntryEntryType.INCREMENT,
     expiry_date=dateutil.parser.parse('2023-01-01').date(),
-    invoice_settings=operations.CreateLedgerEntryRequestBodyInvoiceSettings(
+    invoice_settings=shared.NewCreditLedgerEntryInvoiceSettings(
         auto_collection=False,
         memo='excepturi',
         net_terms=1352.18,
@@ -174,7 +174,7 @@ s = orb.Orb(
 
 res = s.credit.fetch('iste')
 
-if res.fetch_customer_credits_200_application_json_object is not None:
+if res.credits is not None:
     # handle response
 ```
 
@@ -197,7 +197,7 @@ s = orb.Orb(
 
 res = s.credit.fetch_by_external_id('dolor')
 
-if res.fetch_customer_credits_external_id_200_application_json_object is not None:
+if res.credits is not None:
     # handle response
 ```
 
@@ -239,7 +239,7 @@ When a set of credits expire on pre-set expiration date, the customer's balance
 
 ```python
 import orb
-from orb.models import operations
+from orb.models import operations, shared
 
 s = orb.Orb(
     security=shared.Security(
@@ -248,9 +248,9 @@ s = orb.Orb(
 )
 
 
-res = s.credit.fetch_ledger('natus', operations.FetchCustomerCreditsLedgerEntryStatus.COMMITTED, operations.FetchCustomerCreditsLedgerEntryType.CREDIT_BLOCK_EXPIRY, 9025.99)
+res = s.credit.fetch_ledger('natus', shared.EntryStatus.COMMITTED, shared.EntryType.CREDIT_BLOCK_EXPIRY, 9025.99)
 
-if res.fetch_customer_credits_ledger_200_application_json_object is not None:
+if res.credit_ledger_entries is not None:
     # handle response
 ```
 
@@ -262,7 +262,7 @@ This endpoint's resource and semantics exactly mirror [View credits ledger](fetc
 
 ```python
 import orb
-from orb.models import operations
+from orb.models import operations, shared
 
 s = orb.Orb(
     security=shared.Security(
@@ -271,8 +271,8 @@ s = orb.Orb(
 )
 
 
-res = s.credit.fetch_ledger_by_external_id('fuga', operations.FetchCustomerCreditsLedgerExternalIDEntryStatus.COMMITTED, operations.FetchCustomerCreditsLedgerExternalIDEntryType.DECREMENT, 6130.64)
+res = s.credit.fetch_ledger_by_external_id('fuga', shared.EntryStatus.COMMITTED, shared.EntryType.DECREMENT, 6130.64)
 
-if res.fetch_customer_credits_ledger_external_id_200_application_json_object is not None:
+if res.credit_ledger_entries is not None:
     # handle response
 ```

docs/customer/README.md

@@ -163,7 +163,7 @@ if res.amend_usage_external_customer_id_200_application_json_object is not None:
 
 ## create
 
-This operation is used to create an Orb customer, who is party to the core billing relationship. See [Customer](../reference/Orb-API.json/components/schemas/Customer) for an overview of the customer resource.
+This operation is used to create an Orb customer, who is party to the core billing relationship. See [Customer](../guides/concepts#customer) for an overview of the customer resource.
 
 This endpoint is critical in the following Orb functionality:
 * Automated charges can be configured by setting `payment_provider` and `payment_provider_id` to automatically issue invoices
@@ -174,15 +174,15 @@ This endpoint is critical in the following Orb functionality:
 
 ```python
 import orb
-from orb.models import operations, shared
+from orb.models import shared
 
 s = orb.Orb(
     security=shared.Security(
         api_key_auth="YOUR_BEARER_TOKEN_HERE",
     ),
 )
 
-req = operations.CreateCustomerRequestBody(
+req = shared.NewCustomer(
     auto_collection=False,
     billing_address=shared.BillingAddress(
         city='North Marguerite',
@@ -202,7 +202,7 @@ req = operations.CreateCustomerRequestBody(
         "cum": 'perferendis',
     },
     name='Bessie Grady II',
-    payment_provider=operations.CreateCustomerRequestBodyPaymentProvider.BILL_COM,
+    payment_provider=shared.NewCustomerPaymentProvider.BILL_COM,
     payment_provider_id='iusto',
     shipping_address=shared.ShippingAddress(
         city='Lake Emilieside',
@@ -228,7 +228,7 @@ if res.customer is not None:
 
 ## create_transaction
 
-Creates an immutable balance transaction that updates the customer's balance and returns back the newly created [transaction](../reference/Orb-API.json/components/schemas/Customer-balance-transaction).
+Creates an immutable balance transaction that updates the customer's balance and returns back the newly created transaction.
 
 ### Example Usage
 
@@ -404,7 +404,7 @@ When a price uses matrix pricing, it's important to view costs grouped by those
 ```python
 import orb
 import dateutil.parser
-from orb.models import operations
+from orb.models import operations, shared
 
 s = orb.Orb(
     security=shared.Security(
@@ -417,12 +417,12 @@ req = operations.FetchCustomerCostsRequest(
     group_by='consequatur',
     timeframe_end='2022-03-01T05:00:00Z',
     timeframe_start=dateutil.parser.isoparse('2022-02-01T05:00:00Z'),
-    view_mode=operations.FetchCustomerCostsViewMode.CUMULATIVE,
+    view_mode=shared.ViewMode.CUMULATIVE,
 )
 
 res = s.customer.fetch_costs(req)
 
-if res.fetch_customer_costs_200_application_json_object is not None:
+if res.customer_costs is not None:
     # handle response
 ```
 
@@ -435,7 +435,7 @@ This endpoint's resource and semantics exactly mirror [View customer costs](fetc
 ```python
 import orb
 import dateutil.parser
-from orb.models import operations
+from orb.models import operations, shared
 
 s = orb.Orb(
     security=shared.Security(
@@ -448,12 +448,12 @@ req = operations.FetchCustomerCostsExternalIDRequest(
     group_by='explicabo',
     timeframe_end='2022-03-01T05:00:00Z',
     timeframe_start=dateutil.parser.isoparse('2022-02-01T05:00:00Z'),
-    view_mode=operations.FetchCustomerCostsExternalIDViewMode.CUMULATIVE,
+    view_mode=shared.ViewMode.CUMULATIVE,
 )
 
 res = s.customer.fetch_costs_by_external_id(req)
 
-if res.fetch_customer_costs_external_id_200_application_json_object is not None:
+if res.customer_costs is not None:
     # handle response
 ```
 
@@ -498,7 +498,7 @@ if res.list_balance_transactions_200_application_json_object is not None:
 
 This endpoint returns a list of all customers for an account. The list of customers is ordered starting from the most recently created customer. This endpoint follows Orb's [standardized pagination format](../api/pagination).
 
-See [Customer](../reference/Orb-API.json/components/schemas/Customer) for an overview of the customer model.
+See [Customer](../guides/concepts#customer) for an overview of the customer model.
 
 ### Example Usage
 
@@ -515,7 +515,7 @@ s = orb.Orb(
 
 res = s.customer.list()
 
-if res.list_customers_200_application_json_object is not None:
+if res.customers is not None:
     # handle response
 ```
 
@@ -584,7 +584,7 @@ s = orb.Orb(
 )
 
 
-res = s.customer.update_customer('facere', operations.UpdateCustomerRequestBody(
+res = s.customer.update_customer('facere', shared.NewCustomer(
     auto_collection=False,
     billing_address=shared.BillingAddress(
         city='Graciechester',
@@ -594,29 +594,29 @@ res = s.customer.update_customer('facere', operations.UpdateCustomerRequestBody(
         postal_code='38965-7655',
         state='sapiente',
     ),
-    email='Luis_Huels@gmail.com',
-    email_delivery=False,
+    currency='amet',
+    email='Golda_Kassulke@yahoo.com',
+    external_customer_id='molestiae',
     metadata={
-        "molestiae": 'perferendis',
         "nihil": 'magnam',
-        "distinctio": 'id',
     },
-    name='Jamie Hoppe',
-    payment_provider=operations.UpdateCustomerRequestBodyPaymentProvider.BILL_COM,
-    payment_provider_id='vero',
+    name='Alfonso Green',
+    payment_provider=shared.NewCustomerPaymentProvider.STRIPE_INVOICE,
+    payment_provider_id='nobis',
     shipping_address=shared.ShippingAddress(
-        city='North Elianeland',
+        city='Shainaville',
         country='US',
-        line1='excepturi',
-        line2='ullam',
-        postal_code='55069-6342',
-        state='necessitatibus',
+        line1='architecto',
+        line2='magnam',
+        postal_code='53555',
+        state='accusantium',
     ),
     tax_id=shared.CustomerTaxID(
-        country='Burundi',
-        type='nemo',
-        value='quasi',
+        country='Niue',
+        type='reiciendis',
+        value='mollitia',
     ),
+    timezone='Etc/UTC',
 ))
 
 if res.customer is not None: