@epilot/pricing-client 3.53.8 → 3.54.0

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/openapi.d.ts CHANGED
@@ -8,6 +8,48 @@ import type {
8
8
 
9
9
  declare namespace Components {
10
10
  namespace Schemas {
11
+ /**
12
+ * Additional data included in the provider entity
13
+ */
14
+ export interface AdditionalProviderData {
15
+ gridOperators: {
16
+ /**
17
+ * The name of the participant
18
+ */
19
+ name: string;
20
+ /**
21
+ * The BDEW/DVGW code number of the participant
22
+ */
23
+ codeNumber: string;
24
+ /**
25
+ * The date from which this data is valid from
26
+ */
27
+ validFrom?: string; // date
28
+ /**
29
+ * The date until which this data is valid to
30
+ */
31
+ validUntil?: string; // date
32
+ }[];
33
+ defaultSuppliers: {
34
+ /**
35
+ * The name of the participant
36
+ */
37
+ name: string;
38
+ /**
39
+ * The BDEW/DVGW code number of the participant
40
+ */
41
+ codeNumber: string;
42
+ /**
43
+ * The date from which this data is valid from
44
+ */
45
+ validFrom?: string; // date
46
+ /**
47
+ * The date until which this data is valid to
48
+ */
49
+ validUntil?: string; // date
50
+ }[];
51
+ marketAreaDetails: /* Market area details for gas */ GasMarketAreaDetails | /* Market area details for power */ PowerMarketAreaDetails;
52
+ }
11
53
  export interface Address {
12
54
  [name: string]: any;
13
55
  /**
@@ -1451,6 +1493,7 @@ declare namespace Components {
1451
1493
  */
1452
1494
  ExternalFeeMappings;
1453
1495
  external_fees_metadata?: ExternalFeeMetadata;
1496
+ external_location_metadata?: /* The provider entity */ ExternalLocationMetadata;
1454
1497
  external_price_metadata?: ExternalPriceMetadata;
1455
1498
  _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails;
1456
1499
  /**
@@ -3696,6 +3739,7 @@ declare namespace Components {
3696
3739
  */
3697
3740
  ExternalFeeMappings;
3698
3741
  external_fees_metadata?: ExternalFeeMetadata;
3742
+ external_location_metadata?: /* The provider entity */ ExternalLocationMetadata;
3699
3743
  external_price_metadata?: ExternalPriceMetadata;
3700
3744
  _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails;
3701
3745
  /**
@@ -4845,6 +4889,28 @@ declare namespace Components {
4845
4889
  [name: string]: any;
4846
4890
  };
4847
4891
  }
4892
+ /**
4893
+ * The provider entity
4894
+ */
4895
+ export interface ExternalLocationMetadata {
4896
+ /**
4897
+ * The provider name
4898
+ */
4899
+ name: string;
4900
+ /**
4901
+ * The provider code
4902
+ */
4903
+ code: string;
4904
+ /**
4905
+ * The type of product
4906
+ */
4907
+ type: "gas" | "power";
4908
+ additionalData: /* Additional data included in the provider entity */ AdditionalProviderData;
4909
+ _meta?: /* Signature meta data payload */ SignatureMeta;
4910
+ inputs?: {
4911
+ [name: string]: any;
4912
+ };
4913
+ }
4848
4914
  export interface ExternalPriceMetadata {
4849
4915
  market: /* The market for a spot market price. */ SpotMarketType;
4850
4916
  bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
@@ -4877,6 +4943,23 @@ declare namespace Components {
4877
4943
  * The concession type for gas
4878
4944
  */
4879
4945
  export type GasConcessionType = "standard" | "special";
4946
+ /**
4947
+ * Market area details for gas
4948
+ */
4949
+ export interface GasMarketAreaDetails {
4950
+ /**
4951
+ * The type of gas used
4952
+ */
4953
+ gasType?: "L-Gas" | "H-Gas";
4954
+ /**
4955
+ * The name of the market area
4956
+ */
4957
+ marketArea?: string;
4958
+ /**
4959
+ * The vritual trading point identifier
4960
+ */
4961
+ virtualTradingPoint?: string;
4962
+ }
4880
4963
  /**
4881
4964
  * A market price at a given point in time.
4882
4965
  */
@@ -5221,6 +5304,27 @@ declare namespace Components {
5221
5304
  };
5222
5305
  }[];
5223
5306
  }
5307
+ /**
5308
+ * Market participant data
5309
+ */
5310
+ export interface MarketParticipant {
5311
+ /**
5312
+ * The name of the participant
5313
+ */
5314
+ name: string;
5315
+ /**
5316
+ * The BDEW/DVGW code number of the participant
5317
+ */
5318
+ codeNumber: string;
5319
+ /**
5320
+ * The date from which this data is valid from
5321
+ */
5322
+ validFrom?: string; // date
5323
+ /**
5324
+ * The date until which this data is valid to
5325
+ */
5326
+ validUntil?: string; // date
5327
+ }
5224
5328
  /**
5225
5329
  * Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.
5226
5330
  * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
@@ -6579,291 +6683,18 @@ declare namespace Components {
6579
6683
  };
6580
6684
  }
6581
6685
  export interface PortalContext {
6686
+ [name: string]: any;
6582
6687
  /**
6583
6688
  * The contract information.
6584
6689
  */
6585
6690
  contract: {
6586
- /**
6587
- * The unique identifier of the contract.
6588
- */
6589
- _id?: string;
6590
- /**
6591
- * Contract Name
6592
- */
6593
- contract_name?: string;
6594
- /**
6595
- * Contract Number
6596
- */
6597
- contract_number?: string;
6598
- /**
6599
- * Assignee user ID
6600
- */
6601
- assignee?: string;
6602
- /**
6603
- * Contract status
6604
- */
6605
- status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired";
6606
- /**
6607
- * Description of the contract
6608
- */
6609
- description?: string;
6610
- /**
6611
- * Billing Account relation
6612
- */
6613
- billing_account?: {
6614
- [key: string]: any;
6615
- };
6616
- /**
6617
- * Account Number
6618
- */
6619
- account_number?: string;
6620
- /**
6621
- * Branch/commodity type (e.g. power, gas, water, waste_water, district_heating, or any custom value)
6622
- */
6623
- branch?: string;
6624
- /**
6625
- * Move In Date
6626
- */
6627
- move_in_date?: string; // date
6628
- /**
6629
- * Move Out Date
6630
- */
6631
- move_out_date?: string; // date
6632
- /**
6633
- * Billing Address
6634
- */
6635
- billing_address?: {
6636
- [key: string]: any;
6637
- };
6638
- /**
6639
- * Delivery Address
6640
- */
6641
- delivery_address?: {
6642
- [key: string]: any;
6643
- }[];
6644
- /**
6645
- * Additional Addresses
6646
- */
6647
- additional_addresses?: {
6648
- [key: string]: any;
6649
- }[];
6650
- /**
6651
- * Date of Termination
6652
- */
6653
- termination_date?: string; // date
6654
- /**
6655
- * Reason For Termination
6656
- */
6657
- termination_reason?: string;
6658
- /**
6659
- * Start Date
6660
- */
6661
- start_date?: string; // date
6662
- /**
6663
- * End Date
6664
- */
6665
- end_date?: string; // date
6666
- /**
6667
- * Customer relation (contact or account)
6668
- */
6669
- customer?: {
6670
- [key: string]: any;
6671
- };
6672
- /**
6673
- * Order relation ID
6674
- */
6675
- order?: string;
6676
- /**
6677
- * Contract type
6678
- */
6679
- type?: "one_time" | "recurring";
6680
- /**
6681
- * Billing Period
6682
- */
6683
- billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
6684
- /**
6685
- * Billing Duration amount
6686
- */
6687
- billing_duration_amount?: number;
6688
- /**
6689
- * Billing Duration Unit
6690
- */
6691
- billing_duration_unit?: "weeks" | "months" | "years";
6692
- /**
6693
- * Notice Time amount
6694
- */
6695
- notice_time_amount?: number;
6696
- /**
6697
- * Notice Time Unit
6698
- */
6699
- notice_time_unit?: "weeks" | "months" | "years";
6700
- /**
6701
- * Termination Time amount
6702
- */
6703
- termination_time_amount?: number;
6704
- /**
6705
- * Termination Time Unit
6706
- */
6707
- termination_time_unit?: "weeks" | "months" | "years";
6708
- /**
6709
- * Renewal Duration amount
6710
- */
6711
- renewal_duration_amount?: number;
6712
- /**
6713
- * Renewal Duration Unit
6714
- */
6715
- renewal_duration_unit?: "weeks" | "months" | "years";
6716
- /**
6717
- * Billing Due Day
6718
- */
6719
- billing_due_day?: number;
6720
- installment_amount?: number;
6721
- /**
6722
- * Balance
6723
- */
6724
- balance?: number;
6725
- /**
6726
- * Meters relation
6727
- */
6728
- meters?: string[];
6729
- /**
6730
- * Payment Details relation
6731
- */
6732
- payment?: {
6733
- [key: string]: any;
6734
- };
6735
- /**
6736
- * Last Sync At
6737
- */
6738
- last_sync_at?: string; // date
6739
- /**
6740
- * External ID
6741
- */
6742
- external_id?: string;
6691
+ [name: string]: any;
6743
6692
  };
6744
6693
  /**
6745
6694
  * The contact information.
6746
6695
  */
6747
6696
  contact: {
6748
- /**
6749
- * The unique identifier of the contact.
6750
- */
6751
- _id?: string;
6752
- /**
6753
- * Salutation
6754
- */
6755
- salutation?: "Mr." | "Ms. / Mrs." | "Company" | "Contact Person" | "Company/Contact Person" | "Spouse" | "Family" | "Ownership" | "Assembly" | "Other";
6756
- /**
6757
- * Title
6758
- */
6759
- title?: "Dr." | "Prof." | "Prof. Dr.";
6760
- /**
6761
- * First Name
6762
- */
6763
- first_name?: string;
6764
- /**
6765
- * Last Name
6766
- */
6767
- last_name?: string;
6768
- /**
6769
- * Customer Number
6770
- */
6771
- customer_number?: string;
6772
- /**
6773
- * Date of Birth
6774
- */
6775
- birthdate?: string; // date
6776
- /**
6777
- * Email addresses
6778
- */
6779
- email?: {
6780
- email?: string; // email
6781
- _primary?: boolean;
6782
- }[];
6783
- /**
6784
- * Phone numbers
6785
- */
6786
- phone?: {
6787
- phone?: string;
6788
- _primary?: boolean;
6789
- }[];
6790
- /**
6791
- * Standard communication method
6792
- */
6793
- communication_preference?: "postal" | "portal";
6794
- /**
6795
- * Addresses
6796
- */
6797
- address?: {
6798
- _primary?: boolean;
6799
- postal_code?: string;
6800
- city?: string;
6801
- street?: string;
6802
- street_number?: string;
6803
- country?: string;
6804
- }[];
6805
- /**
6806
- * Payment methods
6807
- */
6808
- payment?: {
6809
- _primary?: boolean;
6810
- }[];
6811
- /**
6812
- * Account relations
6813
- */
6814
- account?: string[];
6815
- /**
6816
- * Marketing Permission (deprecated)
6817
- */
6818
- marketing_permission?: boolean;
6819
- /**
6820
- * Contact Owner user ID
6821
- */
6822
- contact_owner?: string;
6823
- /**
6824
- * Email Marketing consent
6825
- */
6826
- consent_email_marketing?: {
6827
- [key: string]: any;
6828
- };
6829
- /**
6830
- * SMS Marketing consent
6831
- */
6832
- consent_sms_marketing?: {
6833
- [key: string]: any;
6834
- };
6835
- /**
6836
- * Direct Phone Marketing consent
6837
- */
6838
- consent_phone_call?: {
6839
- [key: string]: any;
6840
- };
6841
- /**
6842
- * Print Marketing consent
6843
- */
6844
- consent_print_marketing?: {
6845
- [key: string]: any;
6846
- };
6847
- /**
6848
- * Portal Users relation
6849
- */
6850
- portal_users?: string[];
6851
- /**
6852
- * Opportunities relation
6853
- */
6854
- opportunities?: string[];
6855
- /**
6856
- * Orders relation
6857
- */
6858
- orders?: string[];
6859
- /**
6860
- * Contracts relation
6861
- */
6862
- contracts?: string[];
6863
- /**
6864
- * External ID
6865
- */
6866
- external_id?: string;
6697
+ [name: string]: any;
6867
6698
  };
6868
6699
  /**
6869
6700
  * Address to use for product availability checks. Include when the catalog should filter products by serviceable area (e.g. postal code coverage).
@@ -6914,6 +6745,19 @@ declare namespace Components {
6914
6745
  journey_target_block?: string;
6915
6746
  }[];
6916
6747
  }
6748
+ /**
6749
+ * Market area details for power
6750
+ */
6751
+ export interface PowerMarketAreaDetails {
6752
+ /**
6753
+ * The EIC of the control zone
6754
+ */
6755
+ controlZone?: string;
6756
+ /**
6757
+ * The EIC of the balancing zone
6758
+ */
6759
+ balancingZone?: string;
6760
+ }
6917
6761
  /**
6918
6762
  * The meter type for power
6919
6763
  */
@@ -8111,6 +7955,7 @@ declare namespace Components {
8111
7955
  */
8112
7956
  ExternalFeeMappings;
8113
7957
  external_fees_metadata?: ExternalFeeMetadata;
7958
+ external_location_metadata?: /* The provider entity */ ExternalLocationMetadata;
8114
7959
  external_price_metadata?: ExternalPriceMetadata;
8115
7960
  _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails;
8116
7961
  /**
@@ -9409,6 +9254,12 @@ declare namespace Components {
9409
9254
  * The provider code
9410
9255
  */
9411
9256
  code: string;
9257
+ /**
9258
+ * The type of product
9259
+ */
9260
+ type: "gas" | "power";
9261
+ additionalData: /* Additional data included in the provider entity */ AdditionalProviderData;
9262
+ _meta?: /* Signature meta data payload */ SignatureMeta;
9412
9263
  }
9413
9264
  /**
9414
9265
  * An amount associated with a specific recurrence.
@@ -9941,7 +9792,7 @@ declare namespace Components {
9941
9792
  */
9942
9793
  recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
9943
9794
  /**
9944
- * The list of cashback sums for each cashback period.
9795
+ * The list of cashbacks applied.
9945
9796
  */
9946
9797
  cashbacks?: (/* A detail associated with a specific cashback. */ CashbackAmount)[];
9947
9798
  /**
@@ -12117,6 +11968,7 @@ export interface PathsDictionary {
12117
11968
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
12118
11969
 
12119
11970
 
11971
+ export type AdditionalProviderData = Components.Schemas.AdditionalProviderData;
12120
11972
  export type Address = Components.Schemas.Address;
12121
11973
  export type Amounts = Components.Schemas.Amounts;
12122
11974
  export type AvailabilityCheckParams = Components.Schemas.AvailabilityCheckParams;
@@ -12177,9 +12029,11 @@ export type ExternalCatalogRequest = Components.Schemas.ExternalCatalogRequest;
12177
12029
  export type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping;
12178
12030
  export type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings;
12179
12031
  export type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata;
12032
+ export type ExternalLocationMetadata = Components.Schemas.ExternalLocationMetadata;
12180
12033
  export type ExternalPriceMetadata = Components.Schemas.ExternalPriceMetadata;
12181
12034
  export type File = Components.Schemas.File;
12182
12035
  export type GasConcessionType = Components.Schemas.GasConcessionType;
12036
+ export type GasMarketAreaDetails = Components.Schemas.GasMarketAreaDetails;
12183
12037
  export type HistoricMarketPriceRecord = Components.Schemas.HistoricMarketPriceRecord;
12184
12038
  export type HistoricMarketPricesResult = Components.Schemas.HistoricMarketPricesResult;
12185
12039
  export type HydratedCompositePrice = Components.Schemas.HydratedCompositePrice;
@@ -12187,6 +12041,7 @@ export type IntegrationAuthCredentials = Components.Schemas.IntegrationAuthCrede
12187
12041
  export type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult;
12188
12042
  export type IntegrationId = Components.Schemas.IntegrationId;
12189
12043
  export type JourneyContext = Components.Schemas.JourneyContext;
12044
+ export type MarketParticipant = Components.Schemas.MarketParticipant;
12190
12045
  export type MarkupPricingModel = Components.Schemas.MarkupPricingModel;
12191
12046
  export type MetaData = Components.Schemas.MetaData;
12192
12047
  export type NonHydratedCompositePrice = Components.Schemas.NonHydratedCompositePrice;
@@ -12202,6 +12057,7 @@ export type OrderSource = Components.Schemas.OrderSource;
12202
12057
  export type OrderStatus = Components.Schemas.OrderStatus;
12203
12058
  export type PaymentMethod = Components.Schemas.PaymentMethod;
12204
12059
  export type PortalContext = Components.Schemas.PortalContext;
12060
+ export type PowerMarketAreaDetails = Components.Schemas.PowerMarketAreaDetails;
12205
12061
  export type PowerMeterType = Components.Schemas.PowerMeterType;
12206
12062
  export type Price = Components.Schemas.Price;
12207
12063
  export type PriceAmounts = Components.Schemas.PriceAmounts;
package/dist/openapi.json CHANGED
@@ -5432,6 +5432,20 @@
5432
5432
  }
5433
5433
  }
5434
5434
  },
5435
+ "ExternalLocationMetadata": {
5436
+ "allOf": [
5437
+ {
5438
+ "$ref": "#/components/schemas/Provider"
5439
+ }
5440
+ ],
5441
+ "type": "object",
5442
+ "properties": {
5443
+ "inputs": {
5444
+ "type": "object",
5445
+ "additionalProperties": true
5446
+ }
5447
+ }
5448
+ },
5435
5449
  "ExternalPriceMetadata": {
5436
5450
  "allOf": [
5437
5451
  {
@@ -6314,13 +6328,140 @@
6314
6328
  "code": {
6315
6329
  "description": "The provider code",
6316
6330
  "type": "string"
6331
+ },
6332
+ "type": {
6333
+ "description": "The type of product",
6334
+ "type": "string",
6335
+ "enum": [
6336
+ "gas",
6337
+ "power"
6338
+ ]
6339
+ },
6340
+ "additionalData": {
6341
+ "$ref": "#/components/schemas/AdditionalProviderData"
6342
+ },
6343
+ "_meta": {
6344
+ "$ref": "#/components/schemas/SignatureMeta"
6317
6345
  }
6318
6346
  },
6319
6347
  "required": [
6320
6348
  "name",
6321
- "code"
6349
+ "code",
6350
+ "type",
6351
+ "additionalData"
6352
+ ]
6353
+ },
6354
+ "AdditionalProviderData": {
6355
+ "description": "Additional data included in the provider entity",
6356
+ "type": "object",
6357
+ "properties": {
6358
+ "gridOperators": {
6359
+ "type": "array",
6360
+ "items": {
6361
+ "allOf": [
6362
+ {
6363
+ "$ref": "#/components/schemas/MarketParticipant"
6364
+ },
6365
+ {
6366
+ "description": "The grid operator"
6367
+ }
6368
+ ]
6369
+ }
6370
+ },
6371
+ "defaultSuppliers": {
6372
+ "type": "array",
6373
+ "items": {
6374
+ "allOf": [
6375
+ {
6376
+ "$ref": "#/components/schemas/MarketParticipant"
6377
+ },
6378
+ {
6379
+ "description": "The default supplier"
6380
+ }
6381
+ ]
6382
+ }
6383
+ },
6384
+ "marketAreaDetails": {
6385
+ "oneOf": [
6386
+ {
6387
+ "$ref": "#/components/schemas/GasMarketAreaDetails"
6388
+ },
6389
+ {
6390
+ "$ref": "#/components/schemas/PowerMarketAreaDetails"
6391
+ }
6392
+ ]
6393
+ }
6394
+ },
6395
+ "required": [
6396
+ "gridOperators",
6397
+ "defaultSuppliers",
6398
+ "marketAreaDetails"
6322
6399
  ]
6323
6400
  },
6401
+ "MarketParticipant": {
6402
+ "description": "Market participant data",
6403
+ "type": "object",
6404
+ "properties": {
6405
+ "name": {
6406
+ "description": "The name of the participant",
6407
+ "type": "string"
6408
+ },
6409
+ "codeNumber": {
6410
+ "description": "The BDEW/DVGW code number of the participant",
6411
+ "type": "string"
6412
+ },
6413
+ "validFrom": {
6414
+ "description": "The date from which this data is valid from",
6415
+ "type": "string",
6416
+ "format": "date"
6417
+ },
6418
+ "validUntil": {
6419
+ "description": "The date until which this data is valid to",
6420
+ "type": "string",
6421
+ "format": "date"
6422
+ }
6423
+ },
6424
+ "required": [
6425
+ "name",
6426
+ "codeNumber"
6427
+ ]
6428
+ },
6429
+ "GasMarketAreaDetails": {
6430
+ "description": "Market area details for gas",
6431
+ "type": "object",
6432
+ "properties": {
6433
+ "gasType": {
6434
+ "description": "The type of gas used",
6435
+ "type": "string",
6436
+ "enum": [
6437
+ "L-Gas",
6438
+ "H-Gas"
6439
+ ]
6440
+ },
6441
+ "marketArea": {
6442
+ "description": "The name of the market area",
6443
+ "type": "string"
6444
+ },
6445
+ "virtualTradingPoint": {
6446
+ "description": "The vritual trading point identifier",
6447
+ "type": "string"
6448
+ }
6449
+ }
6450
+ },
6451
+ "PowerMarketAreaDetails": {
6452
+ "description": "Market area details for power",
6453
+ "type": "object",
6454
+ "properties": {
6455
+ "controlZone": {
6456
+ "description": "The EIC of the control zone",
6457
+ "type": "string"
6458
+ },
6459
+ "balancingZone": {
6460
+ "description": "The EIC of the balancing zone",
6461
+ "type": "string"
6462
+ }
6463
+ }
6464
+ },
6324
6465
  "Street": {
6325
6466
  "description": "The street entity",
6326
6467
  "type": "object",
@@ -6581,6 +6722,9 @@
6581
6722
  "external_fees_metadata": {
6582
6723
  "$ref": "#/components/schemas/ExternalFeeMetadata"
6583
6724
  },
6725
+ "external_location_metadata": {
6726
+ "$ref": "#/components/schemas/ExternalLocationMetadata"
6727
+ },
6584
6728
  "external_price_metadata": {
6585
6729
  "$ref": "#/components/schemas/ExternalPriceMetadata"
6586
6730
  },
@@ -7679,7 +7823,7 @@
7679
7823
  },
7680
7824
  "cashbacks": {
7681
7825
  "type": "array",
7682
- "description": "The list of cashback sums for each cashback period.",
7826
+ "description": "The list of cashbacks applied.",
7683
7827
  "items": {
7684
7828
  "oneOf": [
7685
7829
  {
@@ -9107,416 +9251,17 @@
9107
9251
  },
9108
9252
  "PortalContext": {
9109
9253
  "type": "object",
9110
- "additionalProperties": false,
9254
+ "additionalProperties": true,
9111
9255
  "properties": {
9112
9256
  "contract": {
9113
9257
  "type": "object",
9114
9258
  "description": "The contract information.",
9115
- "properties": {
9116
- "_id": {
9117
- "type": "string",
9118
- "description": "The unique identifier of the contract."
9119
- },
9120
- "contract_name": {
9121
- "type": "string",
9122
- "description": "Contract Name"
9123
- },
9124
- "contract_number": {
9125
- "type": "string",
9126
- "description": "Contract Number"
9127
- },
9128
- "assignee": {
9129
- "type": "string",
9130
- "description": "Assignee user ID"
9131
- },
9132
- "status": {
9133
- "type": "string",
9134
- "description": "Contract status",
9135
- "enum": [
9136
- "draft",
9137
- "in_approval_process",
9138
- "approved",
9139
- "active",
9140
- "deactivated",
9141
- "revoked",
9142
- "terminated",
9143
- "expired"
9144
- ]
9145
- },
9146
- "description": {
9147
- "type": "string",
9148
- "description": "Description of the contract"
9149
- },
9150
- "billing_account": {
9151
- "type": "object",
9152
- "description": "Billing Account relation"
9153
- },
9154
- "account_number": {
9155
- "type": "string",
9156
- "description": "Account Number"
9157
- },
9158
- "branch": {
9159
- "type": "string",
9160
- "description": "Branch/commodity type (e.g. power, gas, water, waste_water, district_heating, or any custom value)"
9161
- },
9162
- "move_in_date": {
9163
- "type": "string",
9164
- "format": "date",
9165
- "description": "Move In Date"
9166
- },
9167
- "move_out_date": {
9168
- "type": "string",
9169
- "format": "date",
9170
- "description": "Move Out Date"
9171
- },
9172
- "billing_address": {
9173
- "description": "Billing Address",
9174
- "type": "object"
9175
- },
9176
- "delivery_address": {
9177
- "description": "Delivery Address",
9178
- "type": "array",
9179
- "items": {
9180
- "type": "object"
9181
- }
9182
- },
9183
- "additional_addresses": {
9184
- "type": "array",
9185
- "description": "Additional Addresses",
9186
- "items": {
9187
- "type": "object"
9188
- }
9189
- },
9190
- "termination_date": {
9191
- "type": "string",
9192
- "format": "date",
9193
- "description": "Date of Termination"
9194
- },
9195
- "termination_reason": {
9196
- "type": "string",
9197
- "description": "Reason For Termination"
9198
- },
9199
- "start_date": {
9200
- "type": "string",
9201
- "format": "date",
9202
- "description": "Start Date"
9203
- },
9204
- "end_date": {
9205
- "type": "string",
9206
- "format": "date",
9207
- "description": "End Date"
9208
- },
9209
- "customer": {
9210
- "type": "object",
9211
- "description": "Customer relation (contact or account)"
9212
- },
9213
- "order": {
9214
- "type": "string",
9215
- "description": "Order relation ID"
9216
- },
9217
- "type": {
9218
- "type": "string",
9219
- "description": "Contract type",
9220
- "enum": [
9221
- "one_time",
9222
- "recurring"
9223
- ]
9224
- },
9225
- "billing_period": {
9226
- "type": "string",
9227
- "description": "Billing Period",
9228
- "enum": [
9229
- "weekly",
9230
- "monthly",
9231
- "every_quarter",
9232
- "every_6_months",
9233
- "yearly"
9234
- ]
9235
- },
9236
- "billing_duration_amount": {
9237
- "type": "number",
9238
- "description": "Billing Duration amount",
9239
- "minimum": 0
9240
- },
9241
- "billing_duration_unit": {
9242
- "type": "string",
9243
- "description": "Billing Duration Unit",
9244
- "enum": [
9245
- "weeks",
9246
- "months",
9247
- "years"
9248
- ]
9249
- },
9250
- "notice_time_amount": {
9251
- "type": "number",
9252
- "description": "Notice Time amount",
9253
- "minimum": 0
9254
- },
9255
- "notice_time_unit": {
9256
- "type": "string",
9257
- "description": "Notice Time Unit",
9258
- "enum": [
9259
- "weeks",
9260
- "months",
9261
- "years"
9262
- ]
9263
- },
9264
- "termination_time_amount": {
9265
- "type": "number",
9266
- "description": "Termination Time amount",
9267
- "minimum": 0
9268
- },
9269
- "termination_time_unit": {
9270
- "type": "string",
9271
- "description": "Termination Time Unit",
9272
- "enum": [
9273
- "weeks",
9274
- "months",
9275
- "years"
9276
- ]
9277
- },
9278
- "renewal_duration_amount": {
9279
- "type": "number",
9280
- "description": "Renewal Duration amount",
9281
- "minimum": 0
9282
- },
9283
- "renewal_duration_unit": {
9284
- "type": "string",
9285
- "description": "Renewal Duration Unit",
9286
- "enum": [
9287
- "weeks",
9288
- "months",
9289
- "years"
9290
- ]
9291
- },
9292
- "billing_due_day": {
9293
- "type": "number",
9294
- "description": "Billing Due Day"
9295
- },
9296
- "installment_amount": {
9297
- "type": "number"
9298
- },
9299
- "balance": {
9300
- "type": "number",
9301
- "description": "Balance"
9302
- },
9303
- "meters": {
9304
- "type": "array",
9305
- "description": "Meters relation",
9306
- "items": {
9307
- "type": "string"
9308
- }
9309
- },
9310
- "payment": {
9311
- "type": "object",
9312
- "description": "Payment Details relation"
9313
- },
9314
- "last_sync_at": {
9315
- "type": "string",
9316
- "format": "date",
9317
- "description": "Last Sync At"
9318
- },
9319
- "external_id": {
9320
- "type": "string",
9321
- "description": "External ID",
9322
- "readOnly": true
9323
- }
9324
- }
9259
+ "additionalProperties": true
9325
9260
  },
9326
9261
  "contact": {
9327
9262
  "type": "object",
9328
9263
  "description": "The contact information.",
9329
- "properties": {
9330
- "_id": {
9331
- "type": "string",
9332
- "description": "The unique identifier of the contact."
9333
- },
9334
- "salutation": {
9335
- "type": "string",
9336
- "description": "Salutation",
9337
- "enum": [
9338
- "Mr.",
9339
- "Ms. / Mrs.",
9340
- "Company",
9341
- "Contact Person",
9342
- "Company/Contact Person",
9343
- "Spouse",
9344
- "Family",
9345
- "Ownership",
9346
- "Assembly",
9347
- "Other"
9348
- ]
9349
- },
9350
- "title": {
9351
- "type": "string",
9352
- "description": "Title",
9353
- "enum": [
9354
- "Dr.",
9355
- "Prof.",
9356
- "Prof. Dr."
9357
- ]
9358
- },
9359
- "first_name": {
9360
- "type": "string",
9361
- "description": "First Name"
9362
- },
9363
- "last_name": {
9364
- "type": "string",
9365
- "description": "Last Name"
9366
- },
9367
- "customer_number": {
9368
- "type": "string",
9369
- "description": "Customer Number"
9370
- },
9371
- "birthdate": {
9372
- "type": "string",
9373
- "format": "date",
9374
- "description": "Date of Birth"
9375
- },
9376
- "email": {
9377
- "type": "array",
9378
- "description": "Email addresses",
9379
- "items": {
9380
- "type": "object",
9381
- "properties": {
9382
- "email": {
9383
- "type": "string",
9384
- "format": "email"
9385
- },
9386
- "_primary": {
9387
- "type": "boolean"
9388
- }
9389
- }
9390
- }
9391
- },
9392
- "phone": {
9393
- "type": "array",
9394
- "description": "Phone numbers",
9395
- "items": {
9396
- "type": "object",
9397
- "properties": {
9398
- "phone": {
9399
- "type": "string"
9400
- },
9401
- "_primary": {
9402
- "type": "boolean"
9403
- }
9404
- }
9405
- }
9406
- },
9407
- "communication_preference": {
9408
- "type": "string",
9409
- "description": "Standard communication method",
9410
- "enum": [
9411
- "postal",
9412
- "portal"
9413
- ]
9414
- },
9415
- "address": {
9416
- "type": "array",
9417
- "description": "Addresses",
9418
- "items": {
9419
- "type": "object",
9420
- "properties": {
9421
- "_primary": {
9422
- "type": "boolean"
9423
- },
9424
- "postal_code": {
9425
- "type": "string"
9426
- },
9427
- "city": {
9428
- "type": "string"
9429
- },
9430
- "street": {
9431
- "type": "string"
9432
- },
9433
- "street_number": {
9434
- "type": "string"
9435
- },
9436
- "country": {
9437
- "type": "string"
9438
- }
9439
- }
9440
- }
9441
- },
9442
- "payment": {
9443
- "type": "array",
9444
- "description": "Payment methods",
9445
- "items": {
9446
- "type": "object",
9447
- "properties": {
9448
- "_primary": {
9449
- "type": "boolean"
9450
- }
9451
- }
9452
- }
9453
- },
9454
- "account": {
9455
- "type": "array",
9456
- "description": "Account relations",
9457
- "items": {
9458
- "type": "string"
9459
- }
9460
- },
9461
- "marketing_permission": {
9462
- "type": "boolean",
9463
- "description": "Marketing Permission (deprecated)",
9464
- "deprecated": true
9465
- },
9466
- "contact_owner": {
9467
- "type": "string",
9468
- "description": "Contact Owner user ID"
9469
- },
9470
- "consent_email_marketing": {
9471
- "type": "object",
9472
- "description": "Email Marketing consent"
9473
- },
9474
- "consent_sms_marketing": {
9475
- "type": "object",
9476
- "description": "SMS Marketing consent"
9477
- },
9478
- "consent_phone_call": {
9479
- "type": "object",
9480
- "description": "Direct Phone Marketing consent"
9481
- },
9482
- "consent_print_marketing": {
9483
- "type": "object",
9484
- "description": "Print Marketing consent"
9485
- },
9486
- "portal_users": {
9487
- "type": "array",
9488
- "description": "Portal Users relation",
9489
- "items": {
9490
- "type": "string"
9491
- }
9492
- },
9493
- "opportunities": {
9494
- "type": "array",
9495
- "description": "Opportunities relation",
9496
- "items": {
9497
- "type": "string"
9498
- }
9499
- },
9500
- "orders": {
9501
- "type": "array",
9502
- "description": "Orders relation",
9503
- "items": {
9504
- "type": "string"
9505
- }
9506
- },
9507
- "contracts": {
9508
- "type": "array",
9509
- "description": "Contracts relation",
9510
- "items": {
9511
- "type": "string"
9512
- }
9513
- },
9514
- "external_id": {
9515
- "type": "string",
9516
- "description": "External ID",
9517
- "readOnly": true
9518
- }
9519
- }
9264
+ "additionalProperties": true
9520
9265
  },
9521
9266
  "availability_address": {
9522
9267
  "type": "object",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/pricing-client",
3
- "version": "3.53.8",
3
+ "version": "3.54.0",
4
4
  "description": "Client for epilot Pricing APIs",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",