@schematichq/schematic-typescript-node 1.0.15 → 1.0.17

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.
@@ -221,6 +221,7 @@ declare namespace api {
221
221
  CreateComponentRequest,
222
222
  DeleteComponentRequest,
223
223
  GetComponentRequest,
224
+ HydrateComponentRequest,
224
225
  ListComponentsRequest,
225
226
  UpdateComponentRequest,
226
227
  ComponentsApi,
@@ -291,6 +292,7 @@ declare namespace api {
291
292
  ListPlansRequest,
292
293
  UpdateAudienceRequest,
293
294
  UpdatePlanRequest,
295
+ UpsertBillingProductPlanRequest,
294
296
  PlansApi,
295
297
  CountWebhookEventsRequest,
296
298
  CountWebhooksRequest,
@@ -332,6 +334,11 @@ declare namespace api {
332
334
  AudienceRequestBodyFromJSONTyped,
333
335
  AudienceRequestBodyToJSON,
334
336
  AudienceRequestBody,
337
+ instanceOfBillingProductPlanResponseData,
338
+ BillingProductPlanResponseDataFromJSON,
339
+ BillingProductPlanResponseDataFromJSONTyped,
340
+ BillingProductPlanResponseDataToJSON,
341
+ BillingProductPlanResponseData,
335
342
  instanceOfBillingProductResponseData,
336
343
  BillingProductResponseDataFromJSON,
337
344
  BillingProductResponseDataFromJSONTyped,
@@ -412,6 +419,11 @@ declare namespace api {
412
419
  CompanySubscriptionResponseDataFromJSONTyped,
413
420
  CompanySubscriptionResponseDataToJSON,
414
421
  CompanySubscriptionResponseData,
422
+ instanceOfComponentHydrateView,
423
+ ComponentHydrateViewFromJSON,
424
+ ComponentHydrateViewFromJSONTyped,
425
+ ComponentHydrateViewToJSON,
426
+ ComponentHydrateView,
415
427
  instanceOfComponentResponseData,
416
428
  ComponentResponseDataFromJSON,
417
429
  ComponentResponseDataFromJSONTyped,
@@ -1215,6 +1227,11 @@ declare namespace api {
1215
1227
  GetWebhookResponseFromJSONTyped,
1216
1228
  GetWebhookResponseToJSON,
1217
1229
  GetWebhookResponse,
1230
+ instanceOfHydrateComponentResponse,
1231
+ HydrateComponentResponseFromJSON,
1232
+ HydrateComponentResponseFromJSONTyped,
1233
+ HydrateComponentResponseToJSON,
1234
+ HydrateComponentResponse,
1218
1235
  instanceOfKeysRequestBody,
1219
1236
  KeysRequestBodyFromJSON,
1220
1237
  KeysRequestBodyFromJSONTyped,
@@ -1636,6 +1653,7 @@ declare namespace api {
1636
1653
  UpdateComponentRequestBodyToJSON,
1637
1654
  UpdateComponentRequestBody,
1638
1655
  UpdateComponentRequestBodyEntityTypeEnum,
1656
+ UpdateComponentRequestBodyStateEnum,
1639
1657
  instanceOfUpdateComponentResponse,
1640
1658
  UpdateComponentResponseFromJSON,
1641
1659
  UpdateComponentResponseFromJSONTyped,
@@ -1736,6 +1754,16 @@ declare namespace api {
1736
1754
  UpdateWebhookResponseFromJSONTyped,
1737
1755
  UpdateWebhookResponseToJSON,
1738
1756
  UpdateWebhookResponse,
1757
+ instanceOfUpsertBillingProductPlanResponse,
1758
+ UpsertBillingProductPlanResponseFromJSON,
1759
+ UpsertBillingProductPlanResponseFromJSONTyped,
1760
+ UpsertBillingProductPlanResponseToJSON,
1761
+ UpsertBillingProductPlanResponse,
1762
+ instanceOfUpsertBillingProductRequestBody,
1763
+ UpsertBillingProductRequestBodyFromJSON,
1764
+ UpsertBillingProductRequestBodyFromJSONTyped,
1765
+ UpsertBillingProductRequestBodyToJSON,
1766
+ UpsertBillingProductRequestBody,
1739
1767
  instanceOfUpsertBillingProductResponse,
1740
1768
  UpsertBillingProductResponseFromJSON,
1741
1769
  UpsertBillingProductResponseFromJSONTyped,
@@ -2391,6 +2419,55 @@ export declare class BillingApi extends runtime.BaseAPI {
2391
2419
  upsertBillingSubscription(requestParameters: UpsertBillingSubscriptionRequest, initOverrides?: RequestInit_2 | runtime.InitOverrideFunction): Promise<UpsertBillingSubscriptionResponse>;
2392
2420
  }
2393
2421
 
2422
+ /**
2423
+ * Schematic API
2424
+ * Schematic API
2425
+ *
2426
+ * The version of the OpenAPI document: 0.1
2427
+ *
2428
+ *
2429
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2430
+ * https://openapi-generator.tech
2431
+ * Do not edit the class manually.
2432
+ */
2433
+ /**
2434
+ * The updated resource
2435
+ * @export
2436
+ * @interface BillingProductPlanResponseData
2437
+ */
2438
+ export declare interface BillingProductPlanResponseData {
2439
+ /**
2440
+ *
2441
+ * @type {string}
2442
+ * @memberof BillingProductPlanResponseData
2443
+ */
2444
+ accountId: string;
2445
+ /**
2446
+ *
2447
+ * @type {string}
2448
+ * @memberof BillingProductPlanResponseData
2449
+ */
2450
+ billingProductId: string;
2451
+ /**
2452
+ *
2453
+ * @type {string}
2454
+ * @memberof BillingProductPlanResponseData
2455
+ */
2456
+ environmentId: string;
2457
+ /**
2458
+ *
2459
+ * @type {string}
2460
+ * @memberof BillingProductPlanResponseData
2461
+ */
2462
+ planId: string;
2463
+ }
2464
+
2465
+ export declare function BillingProductPlanResponseDataFromJSON(json: any): BillingProductPlanResponseData;
2466
+
2467
+ export declare function BillingProductPlanResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingProductPlanResponseData;
2468
+
2469
+ export declare function BillingProductPlanResponseDataToJSON(value?: BillingProductPlanResponseData | null): any;
2470
+
2394
2471
  /**
2395
2472
  * Schematic API
2396
2473
  * Schematic API
@@ -2426,12 +2503,6 @@ export declare interface BillingProductResponseData {
2426
2503
  * @memberof BillingProductResponseData
2427
2504
  */
2428
2505
  currency: string;
2429
- /**
2430
- *
2431
- * @type {Date}
2432
- * @memberof BillingProductResponseData
2433
- */
2434
- deletedAt?: Date;
2435
2506
  /**
2436
2507
  *
2437
2508
  * @type {string}
@@ -2499,12 +2570,6 @@ export declare function BillingProductResponseDataToJSON(value?: BillingProductR
2499
2570
  * @interface BillingSubscriptionResponseData
2500
2571
  */
2501
2572
  export declare interface BillingSubscriptionResponseData {
2502
- /**
2503
- *
2504
- * @type {Date}
2505
- * @memberof BillingSubscriptionResponseData
2506
- */
2507
- deletedAt?: Date;
2508
2573
  /**
2509
2574
  *
2510
2575
  * @type {Date}
@@ -3585,6 +3650,32 @@ export declare function CompanySubscriptionResponseDataFromJSONTyped(json: any,
3585
3650
 
3586
3651
  export declare function CompanySubscriptionResponseDataToJSON(value?: CompanySubscriptionResponseData | null): any;
3587
3652
 
3653
+ /**
3654
+ * The returned resource
3655
+ * @export
3656
+ * @interface ComponentHydrateView
3657
+ */
3658
+ export declare interface ComponentHydrateView {
3659
+ /**
3660
+ *
3661
+ * @type {ComponentResponseData}
3662
+ * @memberof ComponentHydrateView
3663
+ */
3664
+ component?: ComponentResponseData;
3665
+ /**
3666
+ *
3667
+ * @type {object}
3668
+ * @memberof ComponentHydrateView
3669
+ */
3670
+ data: object;
3671
+ }
3672
+
3673
+ export declare function ComponentHydrateViewFromJSON(json: any): ComponentHydrateView;
3674
+
3675
+ export declare function ComponentHydrateViewFromJSONTyped(json: any, ignoreDiscriminator: boolean): ComponentHydrateView;
3676
+
3677
+ export declare function ComponentHydrateViewToJSON(value?: ComponentHydrateView | null): any;
3678
+
3588
3679
  /**
3589
3680
  * Schematic API
3590
3681
  * Schematic API
@@ -3597,7 +3688,7 @@ export declare function CompanySubscriptionResponseDataToJSON(value?: CompanySub
3597
3688
  * Do not edit the class manually.
3598
3689
  */
3599
3690
  /**
3600
- * The updated resource
3691
+ *
3601
3692
  * @export
3602
3693
  * @interface ComponentResponseData
3603
3694
  */
@@ -3626,6 +3717,12 @@ export declare interface ComponentResponseData {
3626
3717
  * @memberof ComponentResponseData
3627
3718
  */
3628
3719
  name: string;
3720
+ /**
3721
+ *
3722
+ * @type {string}
3723
+ * @memberof ComponentResponseData
3724
+ */
3725
+ state: string;
3629
3726
  /**
3630
3727
  *
3631
3728
  * @type {string}
@@ -3682,6 +3779,14 @@ export declare class ComponentsApi extends runtime.BaseAPI {
3682
3779
  * Get component
3683
3780
  */
3684
3781
  getComponent(requestParameters: GetComponentRequest, initOverrides?: RequestInit_2 | runtime.InitOverrideFunction): Promise<GetComponentResponse>;
3782
+ /**
3783
+ * Hydrate component
3784
+ */
3785
+ hydrateComponentRaw(requestParameters: HydrateComponentRequest, initOverrides?: RequestInit_2 | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HydrateComponentResponse>>;
3786
+ /**
3787
+ * Hydrate component
3788
+ */
3789
+ hydrateComponent(requestParameters: HydrateComponentRequest, initOverrides?: RequestInit_2 | runtime.InitOverrideFunction): Promise<HydrateComponentResponse>;
3685
3790
  /**
3686
3791
  * List components
3687
3792
  */
@@ -7113,6 +7218,12 @@ export declare interface CreatePlanRequest {
7113
7218
  * @interface CreatePlanRequestBody
7114
7219
  */
7115
7220
  export declare interface CreatePlanRequestBody {
7221
+ /**
7222
+ *
7223
+ * @type {string}
7224
+ * @memberof CreatePlanRequestBody
7225
+ */
7226
+ audienceType?: string;
7116
7227
  /**
7117
7228
  *
7118
7229
  * @type {string}
@@ -7478,12 +7589,6 @@ export declare interface CrmDealLineItem {
7478
7589
  * @memberof CrmDealLineItem
7479
7590
  */
7480
7591
  currency: string;
7481
- /**
7482
- *
7483
- * @type {Date}
7484
- * @memberof CrmDealLineItem
7485
- */
7486
- deletedAt?: Date;
7487
7592
  /**
7488
7593
  *
7489
7594
  * @type {string}
@@ -7599,12 +7704,6 @@ export declare interface CrmDealResponseData {
7599
7704
  * @memberof CrmDealResponseData
7600
7705
  */
7601
7706
  dealId: string;
7602
- /**
7603
- *
7604
- * @type {Date}
7605
- * @memberof CrmDealResponseData
7606
- */
7607
- deletedAt?: Date;
7608
7707
  /**
7609
7708
  *
7610
7709
  * @type {string}
@@ -7678,12 +7777,6 @@ export declare interface CrmLineItemResponseData {
7678
7777
  * @memberof CrmLineItemResponseData
7679
7778
  */
7680
7779
  dealId?: string;
7681
- /**
7682
- *
7683
- * @type {Date}
7684
- * @memberof CrmLineItemResponseData
7685
- */
7686
- deletedAt?: Date;
7687
7780
  /**
7688
7781
  *
7689
7782
  * @type {string}
@@ -7745,12 +7838,6 @@ export declare interface CrmProductResponseData {
7745
7838
  * @memberof CrmProductResponseData
7746
7839
  */
7747
7840
  currency: string;
7748
- /**
7749
- *
7750
- * @type {Date}
7751
- * @memberof CrmProductResponseData
7752
- */
7753
- deletedAt?: Date;
7754
7841
  /**
7755
7842
  *
7756
7843
  * @type {string}
@@ -11766,6 +11853,36 @@ export declare type HTTPRequestInit = {
11766
11853
  body?: HTTPBody;
11767
11854
  };
11768
11855
 
11856
+ export declare interface HydrateComponentRequest {
11857
+ componentId: string;
11858
+ }
11859
+
11860
+ /**
11861
+ *
11862
+ * @export
11863
+ * @interface HydrateComponentResponse
11864
+ */
11865
+ export declare interface HydrateComponentResponse {
11866
+ /**
11867
+ *
11868
+ * @type {ComponentHydrateView}
11869
+ * @memberof HydrateComponentResponse
11870
+ */
11871
+ data: ComponentHydrateView;
11872
+ /**
11873
+ * Input parameters
11874
+ * @type {object}
11875
+ * @memberof HydrateComponentResponse
11876
+ */
11877
+ params: object;
11878
+ }
11879
+
11880
+ export declare function HydrateComponentResponseFromJSON(json: any): HydrateComponentResponse;
11881
+
11882
+ export declare function HydrateComponentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HydrateComponentResponse;
11883
+
11884
+ export declare function HydrateComponentResponseToJSON(value?: HydrateComponentResponse | null): any;
11885
+
11769
11886
  export declare function init(apiKey: string, opts?: SchematicOptions): Schematic;
11770
11887
 
11771
11888
  export declare type InitOverrideFunction = (requestContext: {
@@ -11803,6 +11920,11 @@ export declare function instanceOfApiKeyResponseData(value: object): value is Ap
11803
11920
  */
11804
11921
  export declare function instanceOfAudienceRequestBody(value: object): value is AudienceRequestBody;
11805
11922
 
11923
+ /**
11924
+ * Check if a given object implements the BillingProductPlanResponseData interface.
11925
+ */
11926
+ export declare function instanceOfBillingProductPlanResponseData(value: object): value is BillingProductPlanResponseData;
11927
+
11806
11928
  /**
11807
11929
  * Check if a given object implements the BillingProductResponseData interface.
11808
11930
  */
@@ -11883,6 +12005,11 @@ export declare function instanceOfCompanyResponseData(value: object): value is C
11883
12005
  */
11884
12006
  export declare function instanceOfCompanySubscriptionResponseData(value: object): value is CompanySubscriptionResponseData;
11885
12007
 
12008
+ /**
12009
+ * Check if a given object implements the ComponentHydrateView interface.
12010
+ */
12011
+ export declare function instanceOfComponentHydrateView(value: object): value is ComponentHydrateView;
12012
+
11886
12013
  /**
11887
12014
  * Check if a given object implements the ComponentResponseData interface.
11888
12015
  */
@@ -12658,6 +12785,11 @@ export declare function instanceOfGetWebhookEventResponse(value: object): value
12658
12785
  */
12659
12786
  export declare function instanceOfGetWebhookResponse(value: object): value is GetWebhookResponse;
12660
12787
 
12788
+ /**
12789
+ * Check if a given object implements the HydrateComponentResponse interface.
12790
+ */
12791
+ export declare function instanceOfHydrateComponentResponse(value: object): value is HydrateComponentResponse;
12792
+
12661
12793
  /**
12662
12794
  * Check if a given object implements the KeysRequestBody interface.
12663
12795
  */
@@ -13163,6 +13295,16 @@ export declare function instanceOfUpdateWebhookRequestBody(value: object): value
13163
13295
  */
13164
13296
  export declare function instanceOfUpdateWebhookResponse(value: object): value is UpdateWebhookResponse;
13165
13297
 
13298
+ /**
13299
+ * Check if a given object implements the UpsertBillingProductPlanResponse interface.
13300
+ */
13301
+ export declare function instanceOfUpsertBillingProductPlanResponse(value: object): value is UpsertBillingProductPlanResponse;
13302
+
13303
+ /**
13304
+ * Check if a given object implements the UpsertBillingProductRequestBody interface.
13305
+ */
13306
+ export declare function instanceOfUpsertBillingProductRequestBody(value: object): value is UpsertBillingProductRequestBody;
13307
+
13166
13308
  /**
13167
13309
  * Check if a given object implements the UpsertBillingProductResponse interface.
13168
13310
  */
@@ -16126,6 +16268,12 @@ export declare function PlanAudienceResponseDataToJSON(value?: PlanAudienceRespo
16126
16268
  * @interface PlanDetailResponseData
16127
16269
  */
16128
16270
  export declare interface PlanDetailResponseData {
16271
+ /**
16272
+ *
16273
+ * @type {string}
16274
+ * @memberof PlanDetailResponseData
16275
+ */
16276
+ audienceType: string;
16129
16277
  /**
16130
16278
  *
16131
16279
  * @type {number}
@@ -16303,6 +16451,12 @@ export declare function PlanEntitlementResponseDataToJSON(value?: PlanEntitlemen
16303
16451
  * @interface PlanResponseData
16304
16452
  */
16305
16453
  export declare interface PlanResponseData {
16454
+ /**
16455
+ *
16456
+ * @type {string}
16457
+ * @memberof PlanResponseData
16458
+ */
16459
+ audienceType: string;
16306
16460
  /**
16307
16461
  *
16308
16462
  * @type {Date}
@@ -16423,6 +16577,14 @@ export declare class PlansApi extends runtime.BaseAPI {
16423
16577
  * Update plan
16424
16578
  */
16425
16579
  updatePlan(requestParameters: UpdatePlanRequest, initOverrides?: RequestInit_2 | runtime.InitOverrideFunction): Promise<UpdatePlanResponse>;
16580
+ /**
16581
+ * Upsert billing product plan
16582
+ */
16583
+ upsertBillingProductPlanRaw(requestParameters: UpsertBillingProductPlanRequest, initOverrides?: RequestInit_2 | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpsertBillingProductPlanResponse>>;
16584
+ /**
16585
+ * Upsert billing product plan
16586
+ */
16587
+ upsertBillingProductPlan(requestParameters: UpsertBillingProductPlanRequest, initOverrides?: RequestInit_2 | runtime.InitOverrideFunction): Promise<UpsertBillingProductPlanResponse>;
16426
16588
  }
16427
16589
 
16428
16590
  /**
@@ -17263,6 +17425,7 @@ export declare class Schematic {
17263
17425
  Accounts: api.AccountsApi;
17264
17426
  Billing: api.BillingApi;
17265
17427
  Companies: api.CompaniesApi;
17428
+ Components: api.ComponentsApi;
17266
17429
  Crm: api.CrmApi;
17267
17430
  Entitlements: api.EntitlementsApi;
17268
17431
  Events: api.EventsApi;
@@ -17625,6 +17788,12 @@ export declare interface UpdateComponentRequestBody {
17625
17788
  * @memberof UpdateComponentRequestBody
17626
17789
  */
17627
17790
  name?: string;
17791
+ /**
17792
+ *
17793
+ * @type {string}
17794
+ * @memberof UpdateComponentRequestBody
17795
+ */
17796
+ state?: UpdateComponentRequestBodyStateEnum;
17628
17797
  }
17629
17798
 
17630
17799
  /**
@@ -17641,6 +17810,16 @@ export declare function UpdateComponentRequestBodyFromJSON(json: any): UpdateCom
17641
17810
 
17642
17811
  export declare function UpdateComponentRequestBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateComponentRequestBody;
17643
17812
 
17813
+ /**
17814
+ * @export
17815
+ */
17816
+ export declare const UpdateComponentRequestBodyStateEnum: {
17817
+ readonly Draft: "draft";
17818
+ readonly Live: "live";
17819
+ };
17820
+
17821
+ export declare type UpdateComponentRequestBodyStateEnum = (typeof UpdateComponentRequestBodyStateEnum)[keyof typeof UpdateComponentRequestBodyStateEnum];
17822
+
17644
17823
  export declare function UpdateComponentRequestBodyToJSON(value?: UpdateComponentRequestBody | null): any;
17645
17824
 
17646
17825
  /**
@@ -18141,6 +18320,12 @@ export declare interface UpdatePlanRequest {
18141
18320
  * @interface UpdatePlanRequestBody
18142
18321
  */
18143
18322
  export declare interface UpdatePlanRequestBody {
18323
+ /**
18324
+ *
18325
+ * @type {string}
18326
+ * @memberof UpdatePlanRequestBody
18327
+ */
18328
+ audienceType: string;
18144
18329
  /**
18145
18330
  *
18146
18331
  * @type {string}
@@ -18450,10 +18635,72 @@ export declare function UpdateWebhookResponseFromJSONTyped(json: any, ignoreDisc
18450
18635
 
18451
18636
  export declare function UpdateWebhookResponseToJSON(value?: UpdateWebhookResponse | null): any;
18452
18637
 
18638
+ export declare interface UpsertBillingProductPlanRequest {
18639
+ upsertBillingProductRequestBody: UpsertBillingProductRequestBody;
18640
+ planId: string;
18641
+ }
18642
+
18643
+ /**
18644
+ *
18645
+ * @export
18646
+ * @interface UpsertBillingProductPlanResponse
18647
+ */
18648
+ export declare interface UpsertBillingProductPlanResponse {
18649
+ /**
18650
+ *
18651
+ * @type {BillingProductPlanResponseData}
18652
+ * @memberof UpsertBillingProductPlanResponse
18653
+ */
18654
+ data: BillingProductPlanResponseData;
18655
+ /**
18656
+ * Input parameters
18657
+ * @type {object}
18658
+ * @memberof UpsertBillingProductPlanResponse
18659
+ */
18660
+ params: object;
18661
+ }
18662
+
18663
+ export declare function UpsertBillingProductPlanResponseFromJSON(json: any): UpsertBillingProductPlanResponse;
18664
+
18665
+ export declare function UpsertBillingProductPlanResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpsertBillingProductPlanResponse;
18666
+
18667
+ export declare function UpsertBillingProductPlanResponseToJSON(value?: UpsertBillingProductPlanResponse | null): any;
18668
+
18453
18669
  export declare interface UpsertBillingProductRequest {
18454
18670
  createBillingProductRequestBody: CreateBillingProductRequestBody;
18455
18671
  }
18456
18672
 
18673
+ /**
18674
+ * Schematic API
18675
+ * Schematic API
18676
+ *
18677
+ * The version of the OpenAPI document: 0.1
18678
+ *
18679
+ *
18680
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
18681
+ * https://openapi-generator.tech
18682
+ * Do not edit the class manually.
18683
+ */
18684
+ /**
18685
+ *
18686
+ * @export
18687
+ * @interface UpsertBillingProductRequestBody
18688
+ */
18689
+ export declare interface UpsertBillingProductRequestBody {
18690
+ /**
18691
+ *
18692
+ * @type {string}
18693
+ * @memberof UpsertBillingProductRequestBody
18694
+ */
18695
+ billingProductID: string;
18696
+ }
18697
+
18698
+ export declare function UpsertBillingProductRequestBodyFromJSON(json: any): UpsertBillingProductRequestBody;
18699
+
18700
+ export declare function UpsertBillingProductRequestBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpsertBillingProductRequestBody;
18701
+
18702
+ export declare function UpsertBillingProductRequestBodyToJSON(value?: UpsertBillingProductRequestBody | null): any;
18703
+
18457
18704
  /**
18458
18705
  *
18459
18706
  * @export