Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .fern/metadata.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"cliVersion": "5.50.0",
"generatorName": "fernapi/fern-python-sdk",
"generatorVersion": "5.29.1",
"generatorVersion": "5.29.2",
"generatorConfig": {
"inline_request_params": true,
"client": {
Expand All @@ -23,10 +23,10 @@
}
]
},
"originGitCommit": "008b7147a27272499bf4b17fa96d4357ca3b62e9",
"originGitCommit": "686551a0297d2f37075b3586b030ff32be5c94f7",
"originGitCommitIsDirty": false,
"invokedBy": "ci",
"requestedVersion": "1.3.4",
"requestedVersion": "1.3.5",
"ciProvider": "github",
"sdkVersion": "1.3.4"
"sdkVersion": "1.3.5"
}
8 changes: 7 additions & 1 deletion .fern/replay.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

551 changes: 207 additions & 344 deletions poetry.lock

Large diffs are not rendered by default.

178 changes: 172 additions & 6 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1479,6 +1479,14 @@ client.accounts.update_onboarding_state()
<dl>
<dd>

**dismissed:** `typing.Optional[bool]`

</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[OnboardingPath]`

</dd>
Expand Down Expand Up @@ -16260,6 +16268,14 @@ client.plans.retry_custom_plan_billing(
<dl>
<dd>

**billing_cycle_anchor:** `typing.Optional[datetime.datetime]` — The date the subscription's billing period renews on. Only honored when the retry creates a subscription.

</dd>
</dl>

<dl>
<dd>

**days_until_due:** `typing.Optional[int]`

</dd>
Expand All @@ -16268,6 +16284,14 @@ client.plans.retry_custom_plan_billing(
<dl>
<dd>

**prorate_first_period:** `typing.Optional[bool]` — When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true.

</dd>
</dl>

<dl>
<dd>

**send_invoice:** `typing.Optional[bool]` — Whether Stripe emails the invoice when it is finalized. Defaults to true.

</dd>
Expand Down Expand Up @@ -17566,7 +17590,7 @@ client.plans.publish_plan_version(
excluded_company_ids=[
"excluded_company_ids"
],
migration_strategy="immediate",
migration_strategy="end_of_billing_period",
)

```
Expand Down Expand Up @@ -17623,6 +17647,14 @@ client.plans.publish_plan_version(
<dl>
<dd>

**billing_cycle_anchor:** `typing.Optional[datetime.datetime]` — The date the subscription's billing period renews on. Only honored on a first publish that starts a subscription.

</dd>
</dl>

<dl>
<dd>

**coupon_external_id:** `typing.Optional[str]`

</dd>
Expand Down Expand Up @@ -17663,6 +17695,14 @@ client.plans.publish_plan_version(
<dl>
<dd>

**prorate_first_period:** `typing.Optional[bool]` — When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true.

</dd>
</dl>

<dl>
<dd>

**proration_behavior:** `typing.Optional[MigrationProrationBehavior]`

</dd>
Expand Down Expand Up @@ -23022,7 +23062,7 @@ client = Schematic(
client.planmigrations.list_company_migrations(
migration_id="migration_id",
q="q",
status="completed",
status="cancelled",
limit=1000000,
offset=1000000,
)
Expand Down Expand Up @@ -23176,7 +23216,7 @@ client = Schematic(
client.planmigrations.count_company_migrations(
migration_id="migration_id",
q="q",
status="completed",
status="cancelled",
limit=1000000,
offset=1000000,
)
Expand Down Expand Up @@ -23270,7 +23310,7 @@ client = Schematic(

client.planmigrations.list_migrations(
plan_version_id="plan_version_id",
status="completed",
status="cancelled",
limit=1000000,
offset=1000000,
)
Expand Down Expand Up @@ -23357,7 +23397,7 @@ client = Schematic(
client.planmigrations.create_migration(
plan_id="plan_id",
plan_version_id_to="plan_version_id_to",
strategy="immediate",
strategy="end_of_billing_period",
target_plan_type="plan",
)

Expand Down Expand Up @@ -23506,6 +23546,132 @@ client.planmigrations.get_migration(
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.planmigrations.<a href="src/schematic/planmigrations/client.py">cancel_migration</a>(...) -> CancelMigrationResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from schematic import Schematic
from schematic.environment import SchematicEnvironment

client = Schematic(
api_key="<value>",
environment=SchematicEnvironment.DEFAULT,
)

client.planmigrations.cancel_migration(
plan_version_migration_id="plan_version_migration_id",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**plan_version_migration_id:** `str` — plan_version_migration_id

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.planmigrations.<a href="src/schematic/planmigrations/client.py">complete_migration_now</a>(...) -> CompleteMigrationNowResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from schematic import Schematic
from schematic.environment import SchematicEnvironment

client = Schematic(
api_key="<value>",
environment=SchematicEnvironment.DEFAULT,
)

client.planmigrations.complete_migration_now(
plan_version_migration_id="plan_version_migration_id",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**plan_version_migration_id:** `str` — plan_version_migration_id

</dd>
</dl>

<dl>
<dd>

**proration_behavior:** `typing.Optional[MigrationProrationBehavior]`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>
Expand Down Expand Up @@ -23603,7 +23769,7 @@ client = Schematic(

client.planmigrations.count_migrations(
plan_version_id="plan_version_id",
status="completed",
status="cancelled",
limit=1000000,
offset=1000000,
)
Expand Down
12 changes: 12 additions & 0 deletions src/schematic/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -306,11 +306,13 @@
OnboardingRequirement,
OnboardingRequirementStatus,
OnboardingRequirementView,
OnboardingStripeImport,
OnboardingTrack,
OrbIntegrationConfig,
OrderedPlansInGroup,
PaymentMethodRequestBody,
PaymentMethodResponseData,
PendingMigrationResponseData,
PlanBillingSource,
PlanBundleAction,
PlanBundleCreditGrantRequestBody,
Expand Down Expand Up @@ -826,6 +828,8 @@
from .planbundle import CreateCustomPlanBundleResponse, CreatePlanBundleResponse, UpdatePlanBundleResponse
from .plangroups import CreatePlanGroupResponse, GetPlanGroupParams, GetPlanGroupResponse, UpdatePlanGroupResponse
from .planmigrations import (
CancelMigrationResponse,
CompleteMigrationNowResponse,
CountCompanyMigrationsParams,
CountCompanyMigrationsResponse,
CountMigrationsParams,
Expand Down Expand Up @@ -961,6 +965,7 @@
"BillingSubscriptionView": ".types",
"BillingTiersMode": ".types",
"BindCatalogResponse": ".components",
"CancelMigrationResponse": ".planmigrations",
"CancelSubscriptionResponse": ".checkout",
"CaptureRawEvent": ".types",
"CaptureRawEventBatch": ".types",
Expand Down Expand Up @@ -1025,6 +1030,7 @@
"ComparableOperator": ".types",
"CompatiblePlans": ".types",
"CompatiblePlansResponseData": ".types",
"CompleteMigrationNowResponse": ".planmigrations",
"ComponentCapabilities": ".types",
"ComponentCheckoutSettings": ".types",
"ComponentDisplaySettings": ".types",
Expand Down Expand Up @@ -1511,11 +1517,13 @@
"OnboardingRequirement": ".types",
"OnboardingRequirementStatus": ".types",
"OnboardingRequirementView": ".types",
"OnboardingStripeImport": ".types",
"OnboardingTrack": ".types",
"OrbIntegrationConfig": ".types",
"OrderedPlansInGroup": ".types",
"PaymentMethodRequestBody": ".types",
"PaymentMethodResponseData": ".types",
"PendingMigrationResponseData": ".types",
"PlanBillingSource": ".types",
"PlanBundleAction": ".types",
"PlanBundleCreditGrantRequestBody": ".types",
Expand Down Expand Up @@ -1846,6 +1854,7 @@ def __dir__():
"BillingSubscriptionView",
"BillingTiersMode",
"BindCatalogResponse",
"CancelMigrationResponse",
"CancelSubscriptionResponse",
"CaptureRawEvent",
"CaptureRawEventBatch",
Expand Down Expand Up @@ -1910,6 +1919,7 @@ def __dir__():
"ComparableOperator",
"CompatiblePlans",
"CompatiblePlansResponseData",
"CompleteMigrationNowResponse",
"ComponentCapabilities",
"ComponentCheckoutSettings",
"ComponentDisplaySettings",
Expand Down Expand Up @@ -2396,11 +2406,13 @@ def __dir__():
"OnboardingRequirement",
"OnboardingRequirementStatus",
"OnboardingRequirementView",
"OnboardingStripeImport",
"OnboardingTrack",
"OrbIntegrationConfig",
"OrderedPlansInGroup",
"PaymentMethodRequestBody",
"PaymentMethodResponseData",
"PendingMigrationResponseData",
"PlanBillingSource",
"PlanBundleAction",
"PlanBundleCreditGrantRequestBody",
Expand Down
Loading
Loading