@schematichq/schematic-typescript-node 1.2.4 → 1.2.5
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.
- package/dist/Client.d.ts +11 -57
- package/dist/api/resources/companies/client/Client.d.ts +35 -0
- package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts +28 -0
- package/dist/api/resources/companies/client/requests/index.d.ts +1 -0
- package/dist/api/resources/{features/types/CountAudienceCompaniesResponse.d.ts → companies/types/GetPlanChangeResponse.d.ts} +2 -2
- package/dist/api/resources/companies/types/ListPlanChangesParams.d.ts +17 -0
- package/dist/api/resources/{features/types/CountAudienceUsersResponse.d.ts → companies/types/ListPlanChangesResponse.d.ts} +3 -3
- package/dist/api/resources/companies/types/index.d.ts +3 -0
- package/dist/api/resources/credits/client/Client.d.ts +24 -24
- package/dist/api/resources/features/client/Client.d.ts +0 -112
- package/dist/api/resources/features/types/index.d.ts +0 -4
- package/dist/api/resources/index.d.ts +3 -3
- package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +0 -1
- package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +0 -1
- package/dist/api/resources/plans/client/Client.d.ts +0 -58
- package/dist/api/resources/plans/client/requests/index.d.ts +0 -1
- package/dist/api/resources/plans/types/index.d.ts +0 -3
- package/dist/api/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +2 -1
- package/dist/api/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +2 -1
- package/dist/api/types/CreateOrUpdateConditionGroupRequestBody.d.ts +0 -1
- package/dist/api/types/CreateOrUpdateRuleRequestBodyRuleType.d.ts +1 -2
- package/dist/api/types/PlanChangeResponseData.d.ts +29 -0
- package/dist/api/types/PlanChangeResponseDataAction.d.ts +14 -0
- package/dist/api/types/PlanChangeResponseDataActorType.d.ts +10 -0
- package/dist/api/types/PlanChangeResponseDataBasePlanAction.d.ts +13 -0
- package/dist/api/types/PlanChangeResponseDataSubscriptionChangeAction.d.ts +15 -0
- package/dist/api/types/PlanSnapshotView.d.ts +10 -0
- package/dist/api/types/RuleConditionDetailResponseData.d.ts +0 -1
- package/dist/api/types/RuleConditionGroupDetailResponseData.d.ts +0 -1
- package/dist/api/types/RuleConditionGroupResponseData.d.ts +0 -1
- package/dist/api/types/RuleConditionResponseData.d.ts +0 -1
- package/dist/api/types/RuleDetailResponseData.d.ts +0 -1
- package/dist/api/types/RuleResponseData.d.ts +0 -1
- package/dist/api/types/SubscriptionTraitUpdate.d.ts +12 -0
- package/dist/api/types/index.d.ts +7 -4
- package/dist/index.js +3 -3
- package/dist/serialization/resources/companies/types/GetPlanChangeResponse.d.ts +14 -0
- package/dist/serialization/resources/companies/types/ListPlanChangesParams.d.ts +18 -0
- package/dist/serialization/resources/companies/types/ListPlanChangesResponse.d.ts +15 -0
- package/dist/serialization/resources/companies/types/index.d.ts +3 -0
- package/dist/serialization/resources/features/types/index.d.ts +0 -4
- package/dist/serialization/resources/index.d.ts +3 -3
- package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +0 -1
- package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +0 -1
- package/dist/serialization/resources/plans/client/requests/index.d.ts +0 -1
- package/dist/serialization/resources/plans/types/index.d.ts +0 -3
- package/dist/serialization/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/dist/serialization/types/CreateOrUpdateConditionGroupRequestBody.d.ts +0 -1
- package/dist/serialization/types/CreateOrUpdateRuleRequestBodyRuleType.d.ts +1 -1
- package/dist/serialization/types/PlanChangeResponseData.d.ts +40 -0
- package/dist/serialization/types/PlanChangeResponseDataAction.d.ts +10 -0
- package/dist/serialization/types/PlanChangeResponseDataActorType.d.ts +10 -0
- package/dist/serialization/types/PlanChangeResponseDataBasePlanAction.d.ts +10 -0
- package/dist/serialization/types/PlanChangeResponseDataSubscriptionChangeAction.d.ts +10 -0
- package/dist/serialization/types/PlanSnapshotView.d.ts +16 -0
- package/dist/serialization/types/RuleConditionDetailResponseData.d.ts +0 -1
- package/dist/serialization/types/RuleConditionGroupDetailResponseData.d.ts +0 -1
- package/dist/serialization/types/RuleConditionGroupResponseData.d.ts +0 -1
- package/dist/serialization/types/RuleConditionResponseData.d.ts +0 -1
- package/dist/serialization/types/RuleDetailResponseData.d.ts +0 -1
- package/dist/serialization/types/RuleResponseData.d.ts +0 -1
- package/dist/serialization/types/SubscriptionTraitUpdate.d.ts +18 -0
- package/dist/serialization/types/index.d.ts +7 -4
- package/package.json +1 -1
- package/dist/api/resources/features/types/ListAudienceCompaniesResponse.d.ts +0 -9
- package/dist/api/resources/features/types/ListAudienceUsersResponse.d.ts +0 -9
- package/dist/api/resources/plans/client/requests/UpdateAudienceRequestBody.d.ts +0 -25
- package/dist/api/resources/plans/types/DeleteAudienceResponse.d.ts +0 -9
- package/dist/api/resources/plans/types/GetAudienceResponse.d.ts +0 -9
- package/dist/api/resources/plans/types/UpdateAudienceResponse.d.ts +0 -9
- package/dist/api/types/AudienceRequestBody.d.ts +0 -13
- package/dist/api/types/PaginationFilter.d.ts +0 -9
- package/dist/api/types/PlanAudienceDetailResponseData.d.ts +0 -18
- package/dist/api/types/PlanAudienceResponseData.d.ts +0 -15
- package/dist/serialization/resources/features/types/CountAudienceCompaniesResponse.d.ts +0 -14
- package/dist/serialization/resources/features/types/CountAudienceUsersResponse.d.ts +0 -14
- package/dist/serialization/resources/features/types/ListAudienceCompaniesResponse.d.ts +0 -14
- package/dist/serialization/resources/features/types/ListAudienceUsersResponse.d.ts +0 -14
- package/dist/serialization/resources/plans/client/requests/UpdateAudienceRequestBody.d.ts +0 -15
- package/dist/serialization/resources/plans/types/DeleteAudienceResponse.d.ts +0 -14
- package/dist/serialization/resources/plans/types/GetAudienceResponse.d.ts +0 -14
- package/dist/serialization/resources/plans/types/UpdateAudienceResponse.d.ts +0 -14
- package/dist/serialization/types/AudienceRequestBody.d.ts +0 -18
- package/dist/serialization/types/PaginationFilter.d.ts +0 -13
- package/dist/serialization/types/PlanAudienceDetailResponseData.d.ts +0 -25
- package/dist/serialization/types/PlanAudienceResponseData.d.ts +0 -21
|
@@ -1,7 +1,4 @@
|
|
|
1
1
|
export * from "./UpdateCompanyPlansResponse";
|
|
2
|
-
export * from "./GetAudienceResponse";
|
|
3
|
-
export * from "./UpdateAudienceResponse";
|
|
4
|
-
export * from "./DeleteAudienceResponse";
|
|
5
2
|
export * from "./ListPlansRequestPlanType";
|
|
6
3
|
export * from "./ListPlansResponseParamsPlanType";
|
|
7
4
|
export * from "./ListPlansParams";
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
export type CreateWebhookRequestBodyRequestTypesItem = "company.updated" | "user.updated" | "plan.updated" | "plan.entitlement.updated" | "company.override.updated" | "feature.updated" | "flag.updated" | "flag_rules.updated" | "company.created" | "user.created" | "plan.created" | "plan.entitlement.created" | "company.override.created" | "feature.created" | "flag.created" | "company.deleted" | "user.deleted" | "plan.deleted" | "plan.entitlement.deleted" | "company.override.deleted" | "feature.deleted" | "flag.deleted" | "test.send" | "subscription.trial.ended" | "entitlement.limit.warning" | "entitlement.limit.reached" | "entitlement.soft_limit.warning" | "entitlement.soft_limit.reached" | "entitlement.tier_limit.warning" | "entitlement.tier_limit.reached" | "credit.limit.warning" | "credit.limit.reached";
|
|
4
|
+
export type CreateWebhookRequestBodyRequestTypesItem = "company.updated" | "user.updated" | "plan.updated" | "plan.entitlement.updated" | "company.override.updated" | "feature.updated" | "flag.updated" | "flag_rules.updated" | "company.created" | "user.created" | "plan.created" | "plan.entitlement.created" | "company.override.created" | "feature.created" | "flag.created" | "company.deleted" | "user.deleted" | "plan.deleted" | "plan.entitlement.deleted" | "company.override.deleted" | "feature.deleted" | "flag.deleted" | "test.send" | "subscription.trial.ended" | "entitlement.limit.warning" | "entitlement.limit.reached" | "entitlement.soft_limit.warning" | "entitlement.soft_limit.reached" | "entitlement.tier_limit.warning" | "entitlement.tier_limit.reached" | "credit.limit.warning" | "credit.limit.reached" | "company.plan_change";
|
|
5
5
|
export declare const CreateWebhookRequestBodyRequestTypesItem: {
|
|
6
6
|
readonly CompanyUpdated: "company.updated";
|
|
7
7
|
readonly UserUpdated: "user.updated";
|
|
@@ -35,4 +35,5 @@ export declare const CreateWebhookRequestBodyRequestTypesItem: {
|
|
|
35
35
|
readonly EntitlementTierLimitReached: "entitlement.tier_limit.reached";
|
|
36
36
|
readonly CreditLimitWarning: "credit.limit.warning";
|
|
37
37
|
readonly CreditLimitReached: "credit.limit.reached";
|
|
38
|
+
readonly CompanyPlanChange: "company.plan_change";
|
|
38
39
|
};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
export type UpdateWebhookRequestBodyRequestTypesItem = "company.updated" | "user.updated" | "plan.updated" | "plan.entitlement.updated" | "company.override.updated" | "feature.updated" | "flag.updated" | "flag_rules.updated" | "company.created" | "user.created" | "plan.created" | "plan.entitlement.created" | "company.override.created" | "feature.created" | "flag.created" | "company.deleted" | "user.deleted" | "plan.deleted" | "plan.entitlement.deleted" | "company.override.deleted" | "feature.deleted" | "flag.deleted" | "test.send" | "subscription.trial.ended" | "entitlement.limit.warning" | "entitlement.limit.reached" | "entitlement.soft_limit.warning" | "entitlement.soft_limit.reached" | "entitlement.tier_limit.warning" | "entitlement.tier_limit.reached" | "credit.limit.warning" | "credit.limit.reached";
|
|
4
|
+
export type UpdateWebhookRequestBodyRequestTypesItem = "company.updated" | "user.updated" | "plan.updated" | "plan.entitlement.updated" | "company.override.updated" | "feature.updated" | "flag.updated" | "flag_rules.updated" | "company.created" | "user.created" | "plan.created" | "plan.entitlement.created" | "company.override.created" | "feature.created" | "flag.created" | "company.deleted" | "user.deleted" | "plan.deleted" | "plan.entitlement.deleted" | "company.override.deleted" | "feature.deleted" | "flag.deleted" | "test.send" | "subscription.trial.ended" | "entitlement.limit.warning" | "entitlement.limit.reached" | "entitlement.soft_limit.warning" | "entitlement.soft_limit.reached" | "entitlement.tier_limit.warning" | "entitlement.tier_limit.reached" | "credit.limit.warning" | "credit.limit.reached" | "company.plan_change";
|
|
5
5
|
export declare const UpdateWebhookRequestBodyRequestTypesItem: {
|
|
6
6
|
readonly CompanyUpdated: "company.updated";
|
|
7
7
|
readonly UserUpdated: "user.updated";
|
|
@@ -35,4 +35,5 @@ export declare const UpdateWebhookRequestBodyRequestTypesItem: {
|
|
|
35
35
|
readonly EntitlementTierLimitReached: "entitlement.tier_limit.reached";
|
|
36
36
|
readonly CreditLimitWarning: "credit.limit.warning";
|
|
37
37
|
readonly CreditLimitReached: "credit.limit.reached";
|
|
38
|
+
readonly CompanyPlanChange: "company.plan_change";
|
|
38
39
|
};
|
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
export type CreateOrUpdateRuleRequestBodyRuleType = "global_override" | "company_override" | "plan_entitlement" | "standard" | "default"
|
|
4
|
+
export type CreateOrUpdateRuleRequestBodyRuleType = "global_override" | "company_override" | "plan_entitlement" | "standard" | "default";
|
|
5
5
|
export declare const CreateOrUpdateRuleRequestBodyRuleType: {
|
|
6
6
|
readonly GlobalOverride: "global_override";
|
|
7
7
|
readonly CompanyOverride: "company_override";
|
|
8
8
|
readonly PlanEntitlement: "plan_entitlement";
|
|
9
9
|
readonly Standard: "standard";
|
|
10
10
|
readonly Default: "default";
|
|
11
|
-
readonly PlanAudience: "plan_audience";
|
|
12
11
|
};
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Schematic from "../index";
|
|
5
|
+
export interface PlanChangeResponseData {
|
|
6
|
+
action: Schematic.PlanChangeResponseDataAction;
|
|
7
|
+
actorType: Schematic.PlanChangeResponseDataActorType;
|
|
8
|
+
addOnsAdded: Schematic.PlanSnapshotView[];
|
|
9
|
+
addOnsRemoved: Schematic.PlanSnapshotView[];
|
|
10
|
+
apiKey?: Schematic.ApiKeyResponseData;
|
|
11
|
+
apiKeyRequest?: Schematic.ApiKeyRequestListResponseData;
|
|
12
|
+
basePlan?: Schematic.PlanSnapshotView;
|
|
13
|
+
/** Any special behavior that affected the assignment of the base plan during this change. */
|
|
14
|
+
basePlanAction?: Schematic.PlanChangeResponseDataBasePlanAction;
|
|
15
|
+
company?: Schematic.CompanyResponseData;
|
|
16
|
+
companyId: string;
|
|
17
|
+
createdAt: Date;
|
|
18
|
+
environmentId: string;
|
|
19
|
+
id: string;
|
|
20
|
+
previousBasePlan?: Schematic.PlanSnapshotView;
|
|
21
|
+
requestId?: string;
|
|
22
|
+
/** If a subscription was changed as a part of this plan change, indicates the type of change that was made. */
|
|
23
|
+
subscriptionChangeAction?: Schematic.PlanChangeResponseDataSubscriptionChangeAction;
|
|
24
|
+
/** Any traits were updated as part of this plan change (via pay-in-advance entitlements). */
|
|
25
|
+
traitsUpdated: Schematic.SubscriptionTraitUpdate[];
|
|
26
|
+
updatedAt: Date;
|
|
27
|
+
userId?: string;
|
|
28
|
+
userName?: string;
|
|
29
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type PlanChangeResponseDataAction = "checkout" | "company_upsert" | "fallback_plan" | "manage_plan" | "plan_billing_product_changed" | "plan_deleted" | "quickstart" | "subscription_change";
|
|
5
|
+
export declare const PlanChangeResponseDataAction: {
|
|
6
|
+
readonly Checkout: "checkout";
|
|
7
|
+
readonly CompanyUpsert: "company_upsert";
|
|
8
|
+
readonly FallbackPlan: "fallback_plan";
|
|
9
|
+
readonly ManagePlan: "manage_plan";
|
|
10
|
+
readonly PlanBillingProductChanged: "plan_billing_product_changed";
|
|
11
|
+
readonly PlanDeleted: "plan_deleted";
|
|
12
|
+
readonly Quickstart: "quickstart";
|
|
13
|
+
readonly SubscriptionChange: "subscription_change";
|
|
14
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type PlanChangeResponseDataActorType = "app_user" | "api_key" | "system" | "temporary_access_token";
|
|
5
|
+
export declare const PlanChangeResponseDataActorType: {
|
|
6
|
+
readonly AppUser: "app_user";
|
|
7
|
+
readonly ApiKey: "api_key";
|
|
8
|
+
readonly System: "system";
|
|
9
|
+
readonly TemporaryAccessToken: "temporary_access_token";
|
|
10
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Any special behavior that affected the assignment of the base plan during this change.
|
|
6
|
+
*/
|
|
7
|
+
export type PlanChangeResponseDataBasePlanAction = "fallback" | "initial" | "trait" | "trial_expiry";
|
|
8
|
+
export declare const PlanChangeResponseDataBasePlanAction: {
|
|
9
|
+
readonly Fallback: "fallback";
|
|
10
|
+
readonly Initial: "initial";
|
|
11
|
+
readonly Trait: "trait";
|
|
12
|
+
readonly TrialExpiry: "trial_expiry";
|
|
13
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* If a subscription was changed as a part of this plan change, indicates the type of change that was made.
|
|
6
|
+
*/
|
|
7
|
+
export type PlanChangeResponseDataSubscriptionChangeAction = "downgrade" | "invalid" | "subscribe" | "unsubscribe" | "upgrade" | "upgrade_trial";
|
|
8
|
+
export declare const PlanChangeResponseDataSubscriptionChangeAction: {
|
|
9
|
+
readonly Downgrade: "downgrade";
|
|
10
|
+
readonly Invalid: "invalid";
|
|
11
|
+
readonly Subscribe: "subscribe";
|
|
12
|
+
readonly Unsubscribe: "unsubscribe";
|
|
13
|
+
readonly Upgrade: "upgrade";
|
|
14
|
+
readonly UpgradeTrial: "upgrade_trial";
|
|
15
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export interface SubscriptionTraitUpdate {
|
|
5
|
+
featureId: string;
|
|
6
|
+
hierarchy: string[];
|
|
7
|
+
reason: string;
|
|
8
|
+
traitId: string;
|
|
9
|
+
traitName: string;
|
|
10
|
+
traitType: string;
|
|
11
|
+
value: string;
|
|
12
|
+
}
|
|
@@ -3,7 +3,6 @@ export * from "./ApiKeyCreateResponseData";
|
|
|
3
3
|
export * from "./ApiKeyRequestListResponseData";
|
|
4
4
|
export * from "./ApiKeyRequestResponseData";
|
|
5
5
|
export * from "./ApiKeyResponseData";
|
|
6
|
-
export * from "./AudienceRequestBody";
|
|
7
6
|
export * from "./BillingCouponResponseData";
|
|
8
7
|
export * from "./BillingCreditBundleResponseData";
|
|
9
8
|
export * from "./BillingCreditBundleView";
|
|
@@ -140,11 +139,13 @@ export * from "./ManagePlanRequest";
|
|
|
140
139
|
export * from "./ManagePlanResponseResponseData";
|
|
141
140
|
export * from "./MeterRequestBody";
|
|
142
141
|
export * from "./OrderedPlansInGroup";
|
|
143
|
-
export * from "./PaginationFilter";
|
|
144
142
|
export * from "./PaymentMethodRequestBody";
|
|
145
143
|
export * from "./PaymentMethodResponseData";
|
|
146
|
-
export * from "./
|
|
147
|
-
export * from "./
|
|
144
|
+
export * from "./PlanChangeResponseDataAction";
|
|
145
|
+
export * from "./PlanChangeResponseDataActorType";
|
|
146
|
+
export * from "./PlanChangeResponseDataBasePlanAction";
|
|
147
|
+
export * from "./PlanChangeResponseDataSubscriptionChangeAction";
|
|
148
|
+
export * from "./PlanChangeResponseData";
|
|
148
149
|
export * from "./PlanCreditGrantView";
|
|
149
150
|
export * from "./PlanDetailResponseData";
|
|
150
151
|
export * from "./PlanEntitlementResponseData";
|
|
@@ -157,6 +158,7 @@ export * from "./PlanGroupResponseData";
|
|
|
157
158
|
export * from "./PlanIssueResponseData";
|
|
158
159
|
export * from "./PlanResponseData";
|
|
159
160
|
export * from "./PlanSelection";
|
|
161
|
+
export * from "./PlanSnapshotView";
|
|
160
162
|
export * from "./PlanTraitResponseData";
|
|
161
163
|
export * from "./PreviewObject";
|
|
162
164
|
export * from "./PreviewObjectResponseData";
|
|
@@ -176,6 +178,7 @@ export * from "./RuleResponseData";
|
|
|
176
178
|
export * from "./RulesDetailResponseData";
|
|
177
179
|
export * from "./SegmentStatusResp";
|
|
178
180
|
export * from "./StripeEmbedInfo";
|
|
181
|
+
export * from "./SubscriptionTraitUpdate";
|
|
179
182
|
export * from "./TemporaryAccessTokenResponseData";
|
|
180
183
|
export * from "./TraitDefinition";
|
|
181
184
|
export * from "./UpdateAddOnRequestBody";
|