@epilot/pricing-client 3.53.7 → 3.54.0-pre.1
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 +139 -279
- package/dist/openapi.json +154 -405
- package/package.json +1 -1
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
|
/**
|
|
@@ -1559,9 +1602,13 @@ declare namespace Components {
|
|
|
1559
1602
|
};
|
|
1560
1603
|
}
|
|
1561
1604
|
/**
|
|
1562
|
-
*
|
|
1605
|
+
* A detail associated with a specific cashback.
|
|
1563
1606
|
*/
|
|
1564
1607
|
export interface CashbackAmount {
|
|
1608
|
+
/**
|
|
1609
|
+
* The name of the cashback.
|
|
1610
|
+
*/
|
|
1611
|
+
cashback_name?: string;
|
|
1565
1612
|
cashback_period: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
|
|
1566
1613
|
/**
|
|
1567
1614
|
* The sum of all cashbacks for a specific cashback period
|
|
@@ -3692,6 +3739,7 @@ declare namespace Components {
|
|
|
3692
3739
|
*/
|
|
3693
3740
|
ExternalFeeMappings;
|
|
3694
3741
|
external_fees_metadata?: ExternalFeeMetadata;
|
|
3742
|
+
external_location_metadata?: /* The provider entity */ ExternalLocationMetadata;
|
|
3695
3743
|
external_price_metadata?: ExternalPriceMetadata;
|
|
3696
3744
|
_immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails;
|
|
3697
3745
|
/**
|
|
@@ -4841,6 +4889,28 @@ declare namespace Components {
|
|
|
4841
4889
|
[name: string]: any;
|
|
4842
4890
|
};
|
|
4843
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
|
+
}
|
|
4844
4914
|
export interface ExternalPriceMetadata {
|
|
4845
4915
|
market: /* The market for a spot market price. */ SpotMarketType;
|
|
4846
4916
|
bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
|
|
@@ -4873,6 +4943,23 @@ declare namespace Components {
|
|
|
4873
4943
|
* The concession type for gas
|
|
4874
4944
|
*/
|
|
4875
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
|
+
}
|
|
4876
4963
|
/**
|
|
4877
4964
|
* A market price at a given point in time.
|
|
4878
4965
|
*/
|
|
@@ -5217,6 +5304,27 @@ declare namespace Components {
|
|
|
5217
5304
|
};
|
|
5218
5305
|
}[];
|
|
5219
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
|
+
}
|
|
5220
5328
|
/**
|
|
5221
5329
|
* Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.
|
|
5222
5330
|
* - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
|
|
@@ -6575,291 +6683,18 @@ declare namespace Components {
|
|
|
6575
6683
|
};
|
|
6576
6684
|
}
|
|
6577
6685
|
export interface PortalContext {
|
|
6686
|
+
[name: string]: any;
|
|
6578
6687
|
/**
|
|
6579
6688
|
* The contract information.
|
|
6580
6689
|
*/
|
|
6581
6690
|
contract: {
|
|
6582
|
-
|
|
6583
|
-
* The unique identifier of the contract.
|
|
6584
|
-
*/
|
|
6585
|
-
_id?: string;
|
|
6586
|
-
/**
|
|
6587
|
-
* Contract Name
|
|
6588
|
-
*/
|
|
6589
|
-
contract_name?: string;
|
|
6590
|
-
/**
|
|
6591
|
-
* Contract Number
|
|
6592
|
-
*/
|
|
6593
|
-
contract_number?: string;
|
|
6594
|
-
/**
|
|
6595
|
-
* Assignee user ID
|
|
6596
|
-
*/
|
|
6597
|
-
assignee?: string;
|
|
6598
|
-
/**
|
|
6599
|
-
* Contract status
|
|
6600
|
-
*/
|
|
6601
|
-
status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired";
|
|
6602
|
-
/**
|
|
6603
|
-
* Description of the contract
|
|
6604
|
-
*/
|
|
6605
|
-
description?: string;
|
|
6606
|
-
/**
|
|
6607
|
-
* Billing Account relation
|
|
6608
|
-
*/
|
|
6609
|
-
billing_account?: {
|
|
6610
|
-
[key: string]: any;
|
|
6611
|
-
};
|
|
6612
|
-
/**
|
|
6613
|
-
* Account Number
|
|
6614
|
-
*/
|
|
6615
|
-
account_number?: string;
|
|
6616
|
-
/**
|
|
6617
|
-
* Branch/commodity type (e.g. power, gas, water, waste_water, district_heating, or any custom value)
|
|
6618
|
-
*/
|
|
6619
|
-
branch?: string;
|
|
6620
|
-
/**
|
|
6621
|
-
* Move In Date
|
|
6622
|
-
*/
|
|
6623
|
-
move_in_date?: string; // date
|
|
6624
|
-
/**
|
|
6625
|
-
* Move Out Date
|
|
6626
|
-
*/
|
|
6627
|
-
move_out_date?: string; // date
|
|
6628
|
-
/**
|
|
6629
|
-
* Billing Address
|
|
6630
|
-
*/
|
|
6631
|
-
billing_address?: {
|
|
6632
|
-
[key: string]: any;
|
|
6633
|
-
};
|
|
6634
|
-
/**
|
|
6635
|
-
* Delivery Address
|
|
6636
|
-
*/
|
|
6637
|
-
delivery_address?: {
|
|
6638
|
-
[key: string]: any;
|
|
6639
|
-
}[];
|
|
6640
|
-
/**
|
|
6641
|
-
* Additional Addresses
|
|
6642
|
-
*/
|
|
6643
|
-
additional_addresses?: {
|
|
6644
|
-
[key: string]: any;
|
|
6645
|
-
}[];
|
|
6646
|
-
/**
|
|
6647
|
-
* Date of Termination
|
|
6648
|
-
*/
|
|
6649
|
-
termination_date?: string; // date
|
|
6650
|
-
/**
|
|
6651
|
-
* Reason For Termination
|
|
6652
|
-
*/
|
|
6653
|
-
termination_reason?: string;
|
|
6654
|
-
/**
|
|
6655
|
-
* Start Date
|
|
6656
|
-
*/
|
|
6657
|
-
start_date?: string; // date
|
|
6658
|
-
/**
|
|
6659
|
-
* End Date
|
|
6660
|
-
*/
|
|
6661
|
-
end_date?: string; // date
|
|
6662
|
-
/**
|
|
6663
|
-
* Customer relation (contact or account)
|
|
6664
|
-
*/
|
|
6665
|
-
customer?: {
|
|
6666
|
-
[key: string]: any;
|
|
6667
|
-
};
|
|
6668
|
-
/**
|
|
6669
|
-
* Order relation ID
|
|
6670
|
-
*/
|
|
6671
|
-
order?: string;
|
|
6672
|
-
/**
|
|
6673
|
-
* Contract type
|
|
6674
|
-
*/
|
|
6675
|
-
type?: "one_time" | "recurring";
|
|
6676
|
-
/**
|
|
6677
|
-
* Billing Period
|
|
6678
|
-
*/
|
|
6679
|
-
billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
|
|
6680
|
-
/**
|
|
6681
|
-
* Billing Duration amount
|
|
6682
|
-
*/
|
|
6683
|
-
billing_duration_amount?: number;
|
|
6684
|
-
/**
|
|
6685
|
-
* Billing Duration Unit
|
|
6686
|
-
*/
|
|
6687
|
-
billing_duration_unit?: "weeks" | "months" | "years";
|
|
6688
|
-
/**
|
|
6689
|
-
* Notice Time amount
|
|
6690
|
-
*/
|
|
6691
|
-
notice_time_amount?: number;
|
|
6692
|
-
/**
|
|
6693
|
-
* Notice Time Unit
|
|
6694
|
-
*/
|
|
6695
|
-
notice_time_unit?: "weeks" | "months" | "years";
|
|
6696
|
-
/**
|
|
6697
|
-
* Termination Time amount
|
|
6698
|
-
*/
|
|
6699
|
-
termination_time_amount?: number;
|
|
6700
|
-
/**
|
|
6701
|
-
* Termination Time Unit
|
|
6702
|
-
*/
|
|
6703
|
-
termination_time_unit?: "weeks" | "months" | "years";
|
|
6704
|
-
/**
|
|
6705
|
-
* Renewal Duration amount
|
|
6706
|
-
*/
|
|
6707
|
-
renewal_duration_amount?: number;
|
|
6708
|
-
/**
|
|
6709
|
-
* Renewal Duration Unit
|
|
6710
|
-
*/
|
|
6711
|
-
renewal_duration_unit?: "weeks" | "months" | "years";
|
|
6712
|
-
/**
|
|
6713
|
-
* Billing Due Day
|
|
6714
|
-
*/
|
|
6715
|
-
billing_due_day?: number;
|
|
6716
|
-
installment_amount?: number;
|
|
6717
|
-
/**
|
|
6718
|
-
* Balance
|
|
6719
|
-
*/
|
|
6720
|
-
balance?: number;
|
|
6721
|
-
/**
|
|
6722
|
-
* Meters relation
|
|
6723
|
-
*/
|
|
6724
|
-
meters?: string[];
|
|
6725
|
-
/**
|
|
6726
|
-
* Payment Details relation
|
|
6727
|
-
*/
|
|
6728
|
-
payment?: {
|
|
6729
|
-
[key: string]: any;
|
|
6730
|
-
};
|
|
6731
|
-
/**
|
|
6732
|
-
* Last Sync At
|
|
6733
|
-
*/
|
|
6734
|
-
last_sync_at?: string; // date
|
|
6735
|
-
/**
|
|
6736
|
-
* External ID
|
|
6737
|
-
*/
|
|
6738
|
-
external_id?: string;
|
|
6691
|
+
[name: string]: any;
|
|
6739
6692
|
};
|
|
6740
6693
|
/**
|
|
6741
6694
|
* The contact information.
|
|
6742
6695
|
*/
|
|
6743
6696
|
contact: {
|
|
6744
|
-
|
|
6745
|
-
* The unique identifier of the contact.
|
|
6746
|
-
*/
|
|
6747
|
-
_id?: string;
|
|
6748
|
-
/**
|
|
6749
|
-
* Salutation
|
|
6750
|
-
*/
|
|
6751
|
-
salutation?: "Mr." | "Ms. / Mrs." | "Company" | "Contact Person" | "Company/Contact Person" | "Spouse" | "Family" | "Ownership" | "Assembly" | "Other";
|
|
6752
|
-
/**
|
|
6753
|
-
* Title
|
|
6754
|
-
*/
|
|
6755
|
-
title?: "Dr." | "Prof." | "Prof. Dr.";
|
|
6756
|
-
/**
|
|
6757
|
-
* First Name
|
|
6758
|
-
*/
|
|
6759
|
-
first_name?: string;
|
|
6760
|
-
/**
|
|
6761
|
-
* Last Name
|
|
6762
|
-
*/
|
|
6763
|
-
last_name?: string;
|
|
6764
|
-
/**
|
|
6765
|
-
* Customer Number
|
|
6766
|
-
*/
|
|
6767
|
-
customer_number?: string;
|
|
6768
|
-
/**
|
|
6769
|
-
* Date of Birth
|
|
6770
|
-
*/
|
|
6771
|
-
birthdate?: string; // date
|
|
6772
|
-
/**
|
|
6773
|
-
* Email addresses
|
|
6774
|
-
*/
|
|
6775
|
-
email?: {
|
|
6776
|
-
email?: string; // email
|
|
6777
|
-
_primary?: boolean;
|
|
6778
|
-
}[];
|
|
6779
|
-
/**
|
|
6780
|
-
* Phone numbers
|
|
6781
|
-
*/
|
|
6782
|
-
phone?: {
|
|
6783
|
-
phone?: string;
|
|
6784
|
-
_primary?: boolean;
|
|
6785
|
-
}[];
|
|
6786
|
-
/**
|
|
6787
|
-
* Standard communication method
|
|
6788
|
-
*/
|
|
6789
|
-
communication_preference?: "postal" | "portal";
|
|
6790
|
-
/**
|
|
6791
|
-
* Addresses
|
|
6792
|
-
*/
|
|
6793
|
-
address?: {
|
|
6794
|
-
_primary?: boolean;
|
|
6795
|
-
postal_code?: string;
|
|
6796
|
-
city?: string;
|
|
6797
|
-
street?: string;
|
|
6798
|
-
street_number?: string;
|
|
6799
|
-
country?: string;
|
|
6800
|
-
}[];
|
|
6801
|
-
/**
|
|
6802
|
-
* Payment methods
|
|
6803
|
-
*/
|
|
6804
|
-
payment?: {
|
|
6805
|
-
_primary?: boolean;
|
|
6806
|
-
}[];
|
|
6807
|
-
/**
|
|
6808
|
-
* Account relations
|
|
6809
|
-
*/
|
|
6810
|
-
account?: string[];
|
|
6811
|
-
/**
|
|
6812
|
-
* Marketing Permission (deprecated)
|
|
6813
|
-
*/
|
|
6814
|
-
marketing_permission?: boolean;
|
|
6815
|
-
/**
|
|
6816
|
-
* Contact Owner user ID
|
|
6817
|
-
*/
|
|
6818
|
-
contact_owner?: string;
|
|
6819
|
-
/**
|
|
6820
|
-
* Email Marketing consent
|
|
6821
|
-
*/
|
|
6822
|
-
consent_email_marketing?: {
|
|
6823
|
-
[key: string]: any;
|
|
6824
|
-
};
|
|
6825
|
-
/**
|
|
6826
|
-
* SMS Marketing consent
|
|
6827
|
-
*/
|
|
6828
|
-
consent_sms_marketing?: {
|
|
6829
|
-
[key: string]: any;
|
|
6830
|
-
};
|
|
6831
|
-
/**
|
|
6832
|
-
* Direct Phone Marketing consent
|
|
6833
|
-
*/
|
|
6834
|
-
consent_phone_call?: {
|
|
6835
|
-
[key: string]: any;
|
|
6836
|
-
};
|
|
6837
|
-
/**
|
|
6838
|
-
* Print Marketing consent
|
|
6839
|
-
*/
|
|
6840
|
-
consent_print_marketing?: {
|
|
6841
|
-
[key: string]: any;
|
|
6842
|
-
};
|
|
6843
|
-
/**
|
|
6844
|
-
* Portal Users relation
|
|
6845
|
-
*/
|
|
6846
|
-
portal_users?: string[];
|
|
6847
|
-
/**
|
|
6848
|
-
* Opportunities relation
|
|
6849
|
-
*/
|
|
6850
|
-
opportunities?: string[];
|
|
6851
|
-
/**
|
|
6852
|
-
* Orders relation
|
|
6853
|
-
*/
|
|
6854
|
-
orders?: string[];
|
|
6855
|
-
/**
|
|
6856
|
-
* Contracts relation
|
|
6857
|
-
*/
|
|
6858
|
-
contracts?: string[];
|
|
6859
|
-
/**
|
|
6860
|
-
* External ID
|
|
6861
|
-
*/
|
|
6862
|
-
external_id?: string;
|
|
6697
|
+
[name: string]: any;
|
|
6863
6698
|
};
|
|
6864
6699
|
/**
|
|
6865
6700
|
* Address to use for product availability checks. Include when the catalog should filter products by serviceable area (e.g. postal code coverage).
|
|
@@ -6910,6 +6745,19 @@ declare namespace Components {
|
|
|
6910
6745
|
journey_target_block?: string;
|
|
6911
6746
|
}[];
|
|
6912
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
|
+
}
|
|
6913
6761
|
/**
|
|
6914
6762
|
* The meter type for power
|
|
6915
6763
|
*/
|
|
@@ -8107,6 +7955,7 @@ declare namespace Components {
|
|
|
8107
7955
|
*/
|
|
8108
7956
|
ExternalFeeMappings;
|
|
8109
7957
|
external_fees_metadata?: ExternalFeeMetadata;
|
|
7958
|
+
external_location_metadata?: /* The provider entity */ ExternalLocationMetadata;
|
|
8110
7959
|
external_price_metadata?: ExternalPriceMetadata;
|
|
8111
7960
|
_immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails;
|
|
8112
7961
|
/**
|
|
@@ -9405,6 +9254,12 @@ declare namespace Components {
|
|
|
9405
9254
|
* The provider code
|
|
9406
9255
|
*/
|
|
9407
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;
|
|
9408
9263
|
}
|
|
9409
9264
|
/**
|
|
9410
9265
|
* An amount associated with a specific recurrence.
|
|
@@ -9937,9 +9792,9 @@ declare namespace Components {
|
|
|
9937
9792
|
*/
|
|
9938
9793
|
recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
|
|
9939
9794
|
/**
|
|
9940
|
-
* The list of
|
|
9795
|
+
* The list of cashbacks applied.
|
|
9941
9796
|
*/
|
|
9942
|
-
cashbacks?: (/*
|
|
9797
|
+
cashbacks?: (/* A detail associated with a specific cashback. */ CashbackAmount)[];
|
|
9943
9798
|
/**
|
|
9944
9799
|
* The aggregated price items recurrences by tax rate
|
|
9945
9800
|
*/
|
|
@@ -12113,6 +11968,7 @@ export interface PathsDictionary {
|
|
|
12113
11968
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
12114
11969
|
|
|
12115
11970
|
|
|
11971
|
+
export type AdditionalProviderData = Components.Schemas.AdditionalProviderData;
|
|
12116
11972
|
export type Address = Components.Schemas.Address;
|
|
12117
11973
|
export type Amounts = Components.Schemas.Amounts;
|
|
12118
11974
|
export type AvailabilityCheckParams = Components.Schemas.AvailabilityCheckParams;
|
|
@@ -12173,9 +12029,11 @@ export type ExternalCatalogRequest = Components.Schemas.ExternalCatalogRequest;
|
|
|
12173
12029
|
export type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping;
|
|
12174
12030
|
export type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings;
|
|
12175
12031
|
export type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata;
|
|
12032
|
+
export type ExternalLocationMetadata = Components.Schemas.ExternalLocationMetadata;
|
|
12176
12033
|
export type ExternalPriceMetadata = Components.Schemas.ExternalPriceMetadata;
|
|
12177
12034
|
export type File = Components.Schemas.File;
|
|
12178
12035
|
export type GasConcessionType = Components.Schemas.GasConcessionType;
|
|
12036
|
+
export type GasMarketAreaDetails = Components.Schemas.GasMarketAreaDetails;
|
|
12179
12037
|
export type HistoricMarketPriceRecord = Components.Schemas.HistoricMarketPriceRecord;
|
|
12180
12038
|
export type HistoricMarketPricesResult = Components.Schemas.HistoricMarketPricesResult;
|
|
12181
12039
|
export type HydratedCompositePrice = Components.Schemas.HydratedCompositePrice;
|
|
@@ -12183,6 +12041,7 @@ export type IntegrationAuthCredentials = Components.Schemas.IntegrationAuthCrede
|
|
|
12183
12041
|
export type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult;
|
|
12184
12042
|
export type IntegrationId = Components.Schemas.IntegrationId;
|
|
12185
12043
|
export type JourneyContext = Components.Schemas.JourneyContext;
|
|
12044
|
+
export type MarketParticipant = Components.Schemas.MarketParticipant;
|
|
12186
12045
|
export type MarkupPricingModel = Components.Schemas.MarkupPricingModel;
|
|
12187
12046
|
export type MetaData = Components.Schemas.MetaData;
|
|
12188
12047
|
export type NonHydratedCompositePrice = Components.Schemas.NonHydratedCompositePrice;
|
|
@@ -12198,6 +12057,7 @@ export type OrderSource = Components.Schemas.OrderSource;
|
|
|
12198
12057
|
export type OrderStatus = Components.Schemas.OrderStatus;
|
|
12199
12058
|
export type PaymentMethod = Components.Schemas.PaymentMethod;
|
|
12200
12059
|
export type PortalContext = Components.Schemas.PortalContext;
|
|
12060
|
+
export type PowerMarketAreaDetails = Components.Schemas.PowerMarketAreaDetails;
|
|
12201
12061
|
export type PowerMeterType = Components.Schemas.PowerMeterType;
|
|
12202
12062
|
export type Price = Components.Schemas.Price;
|
|
12203
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"
|
|
6322
6352
|
]
|
|
6323
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"
|
|
6399
|
+
]
|
|
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
|
},
|
|
@@ -7582,8 +7726,12 @@
|
|
|
7582
7726
|
},
|
|
7583
7727
|
"CashbackAmount": {
|
|
7584
7728
|
"type": "object",
|
|
7585
|
-
"description": "
|
|
7729
|
+
"description": "A detail associated with a specific cashback.",
|
|
7586
7730
|
"properties": {
|
|
7731
|
+
"cashback_name": {
|
|
7732
|
+
"type": "string",
|
|
7733
|
+
"description": "The name of the cashback."
|
|
7734
|
+
},
|
|
7587
7735
|
"cashback_period": {
|
|
7588
7736
|
"$ref": "#/components/schemas/CashbackPeriod"
|
|
7589
7737
|
},
|
|
@@ -7675,7 +7823,7 @@
|
|
|
7675
7823
|
},
|
|
7676
7824
|
"cashbacks": {
|
|
7677
7825
|
"type": "array",
|
|
7678
|
-
"description": "The list of
|
|
7826
|
+
"description": "The list of cashbacks applied.",
|
|
7679
7827
|
"items": {
|
|
7680
7828
|
"oneOf": [
|
|
7681
7829
|
{
|
|
@@ -9103,416 +9251,17 @@
|
|
|
9103
9251
|
},
|
|
9104
9252
|
"PortalContext": {
|
|
9105
9253
|
"type": "object",
|
|
9106
|
-
"additionalProperties":
|
|
9254
|
+
"additionalProperties": true,
|
|
9107
9255
|
"properties": {
|
|
9108
9256
|
"contract": {
|
|
9109
9257
|
"type": "object",
|
|
9110
9258
|
"description": "The contract information.",
|
|
9111
|
-
"
|
|
9112
|
-
"_id": {
|
|
9113
|
-
"type": "string",
|
|
9114
|
-
"description": "The unique identifier of the contract."
|
|
9115
|
-
},
|
|
9116
|
-
"contract_name": {
|
|
9117
|
-
"type": "string",
|
|
9118
|
-
"description": "Contract Name"
|
|
9119
|
-
},
|
|
9120
|
-
"contract_number": {
|
|
9121
|
-
"type": "string",
|
|
9122
|
-
"description": "Contract Number"
|
|
9123
|
-
},
|
|
9124
|
-
"assignee": {
|
|
9125
|
-
"type": "string",
|
|
9126
|
-
"description": "Assignee user ID"
|
|
9127
|
-
},
|
|
9128
|
-
"status": {
|
|
9129
|
-
"type": "string",
|
|
9130
|
-
"description": "Contract status",
|
|
9131
|
-
"enum": [
|
|
9132
|
-
"draft",
|
|
9133
|
-
"in_approval_process",
|
|
9134
|
-
"approved",
|
|
9135
|
-
"active",
|
|
9136
|
-
"deactivated",
|
|
9137
|
-
"revoked",
|
|
9138
|
-
"terminated",
|
|
9139
|
-
"expired"
|
|
9140
|
-
]
|
|
9141
|
-
},
|
|
9142
|
-
"description": {
|
|
9143
|
-
"type": "string",
|
|
9144
|
-
"description": "Description of the contract"
|
|
9145
|
-
},
|
|
9146
|
-
"billing_account": {
|
|
9147
|
-
"type": "object",
|
|
9148
|
-
"description": "Billing Account relation"
|
|
9149
|
-
},
|
|
9150
|
-
"account_number": {
|
|
9151
|
-
"type": "string",
|
|
9152
|
-
"description": "Account Number"
|
|
9153
|
-
},
|
|
9154
|
-
"branch": {
|
|
9155
|
-
"type": "string",
|
|
9156
|
-
"description": "Branch/commodity type (e.g. power, gas, water, waste_water, district_heating, or any custom value)"
|
|
9157
|
-
},
|
|
9158
|
-
"move_in_date": {
|
|
9159
|
-
"type": "string",
|
|
9160
|
-
"format": "date",
|
|
9161
|
-
"description": "Move In Date"
|
|
9162
|
-
},
|
|
9163
|
-
"move_out_date": {
|
|
9164
|
-
"type": "string",
|
|
9165
|
-
"format": "date",
|
|
9166
|
-
"description": "Move Out Date"
|
|
9167
|
-
},
|
|
9168
|
-
"billing_address": {
|
|
9169
|
-
"description": "Billing Address",
|
|
9170
|
-
"type": "object"
|
|
9171
|
-
},
|
|
9172
|
-
"delivery_address": {
|
|
9173
|
-
"description": "Delivery Address",
|
|
9174
|
-
"type": "array",
|
|
9175
|
-
"items": {
|
|
9176
|
-
"type": "object"
|
|
9177
|
-
}
|
|
9178
|
-
},
|
|
9179
|
-
"additional_addresses": {
|
|
9180
|
-
"type": "array",
|
|
9181
|
-
"description": "Additional Addresses",
|
|
9182
|
-
"items": {
|
|
9183
|
-
"type": "object"
|
|
9184
|
-
}
|
|
9185
|
-
},
|
|
9186
|
-
"termination_date": {
|
|
9187
|
-
"type": "string",
|
|
9188
|
-
"format": "date",
|
|
9189
|
-
"description": "Date of Termination"
|
|
9190
|
-
},
|
|
9191
|
-
"termination_reason": {
|
|
9192
|
-
"type": "string",
|
|
9193
|
-
"description": "Reason For Termination"
|
|
9194
|
-
},
|
|
9195
|
-
"start_date": {
|
|
9196
|
-
"type": "string",
|
|
9197
|
-
"format": "date",
|
|
9198
|
-
"description": "Start Date"
|
|
9199
|
-
},
|
|
9200
|
-
"end_date": {
|
|
9201
|
-
"type": "string",
|
|
9202
|
-
"format": "date",
|
|
9203
|
-
"description": "End Date"
|
|
9204
|
-
},
|
|
9205
|
-
"customer": {
|
|
9206
|
-
"type": "object",
|
|
9207
|
-
"description": "Customer relation (contact or account)"
|
|
9208
|
-
},
|
|
9209
|
-
"order": {
|
|
9210
|
-
"type": "string",
|
|
9211
|
-
"description": "Order relation ID"
|
|
9212
|
-
},
|
|
9213
|
-
"type": {
|
|
9214
|
-
"type": "string",
|
|
9215
|
-
"description": "Contract type",
|
|
9216
|
-
"enum": [
|
|
9217
|
-
"one_time",
|
|
9218
|
-
"recurring"
|
|
9219
|
-
]
|
|
9220
|
-
},
|
|
9221
|
-
"billing_period": {
|
|
9222
|
-
"type": "string",
|
|
9223
|
-
"description": "Billing Period",
|
|
9224
|
-
"enum": [
|
|
9225
|
-
"weekly",
|
|
9226
|
-
"monthly",
|
|
9227
|
-
"every_quarter",
|
|
9228
|
-
"every_6_months",
|
|
9229
|
-
"yearly"
|
|
9230
|
-
]
|
|
9231
|
-
},
|
|
9232
|
-
"billing_duration_amount": {
|
|
9233
|
-
"type": "number",
|
|
9234
|
-
"description": "Billing Duration amount",
|
|
9235
|
-
"minimum": 0
|
|
9236
|
-
},
|
|
9237
|
-
"billing_duration_unit": {
|
|
9238
|
-
"type": "string",
|
|
9239
|
-
"description": "Billing Duration Unit",
|
|
9240
|
-
"enum": [
|
|
9241
|
-
"weeks",
|
|
9242
|
-
"months",
|
|
9243
|
-
"years"
|
|
9244
|
-
]
|
|
9245
|
-
},
|
|
9246
|
-
"notice_time_amount": {
|
|
9247
|
-
"type": "number",
|
|
9248
|
-
"description": "Notice Time amount",
|
|
9249
|
-
"minimum": 0
|
|
9250
|
-
},
|
|
9251
|
-
"notice_time_unit": {
|
|
9252
|
-
"type": "string",
|
|
9253
|
-
"description": "Notice Time Unit",
|
|
9254
|
-
"enum": [
|
|
9255
|
-
"weeks",
|
|
9256
|
-
"months",
|
|
9257
|
-
"years"
|
|
9258
|
-
]
|
|
9259
|
-
},
|
|
9260
|
-
"termination_time_amount": {
|
|
9261
|
-
"type": "number",
|
|
9262
|
-
"description": "Termination Time amount",
|
|
9263
|
-
"minimum": 0
|
|
9264
|
-
},
|
|
9265
|
-
"termination_time_unit": {
|
|
9266
|
-
"type": "string",
|
|
9267
|
-
"description": "Termination Time Unit",
|
|
9268
|
-
"enum": [
|
|
9269
|
-
"weeks",
|
|
9270
|
-
"months",
|
|
9271
|
-
"years"
|
|
9272
|
-
]
|
|
9273
|
-
},
|
|
9274
|
-
"renewal_duration_amount": {
|
|
9275
|
-
"type": "number",
|
|
9276
|
-
"description": "Renewal Duration amount",
|
|
9277
|
-
"minimum": 0
|
|
9278
|
-
},
|
|
9279
|
-
"renewal_duration_unit": {
|
|
9280
|
-
"type": "string",
|
|
9281
|
-
"description": "Renewal Duration Unit",
|
|
9282
|
-
"enum": [
|
|
9283
|
-
"weeks",
|
|
9284
|
-
"months",
|
|
9285
|
-
"years"
|
|
9286
|
-
]
|
|
9287
|
-
},
|
|
9288
|
-
"billing_due_day": {
|
|
9289
|
-
"type": "number",
|
|
9290
|
-
"description": "Billing Due Day"
|
|
9291
|
-
},
|
|
9292
|
-
"installment_amount": {
|
|
9293
|
-
"type": "number"
|
|
9294
|
-
},
|
|
9295
|
-
"balance": {
|
|
9296
|
-
"type": "number",
|
|
9297
|
-
"description": "Balance"
|
|
9298
|
-
},
|
|
9299
|
-
"meters": {
|
|
9300
|
-
"type": "array",
|
|
9301
|
-
"description": "Meters relation",
|
|
9302
|
-
"items": {
|
|
9303
|
-
"type": "string"
|
|
9304
|
-
}
|
|
9305
|
-
},
|
|
9306
|
-
"payment": {
|
|
9307
|
-
"type": "object",
|
|
9308
|
-
"description": "Payment Details relation"
|
|
9309
|
-
},
|
|
9310
|
-
"last_sync_at": {
|
|
9311
|
-
"type": "string",
|
|
9312
|
-
"format": "date",
|
|
9313
|
-
"description": "Last Sync At"
|
|
9314
|
-
},
|
|
9315
|
-
"external_id": {
|
|
9316
|
-
"type": "string",
|
|
9317
|
-
"description": "External ID",
|
|
9318
|
-
"readOnly": true
|
|
9319
|
-
}
|
|
9320
|
-
}
|
|
9259
|
+
"additionalProperties": true
|
|
9321
9260
|
},
|
|
9322
9261
|
"contact": {
|
|
9323
9262
|
"type": "object",
|
|
9324
9263
|
"description": "The contact information.",
|
|
9325
|
-
"
|
|
9326
|
-
"_id": {
|
|
9327
|
-
"type": "string",
|
|
9328
|
-
"description": "The unique identifier of the contact."
|
|
9329
|
-
},
|
|
9330
|
-
"salutation": {
|
|
9331
|
-
"type": "string",
|
|
9332
|
-
"description": "Salutation",
|
|
9333
|
-
"enum": [
|
|
9334
|
-
"Mr.",
|
|
9335
|
-
"Ms. / Mrs.",
|
|
9336
|
-
"Company",
|
|
9337
|
-
"Contact Person",
|
|
9338
|
-
"Company/Contact Person",
|
|
9339
|
-
"Spouse",
|
|
9340
|
-
"Family",
|
|
9341
|
-
"Ownership",
|
|
9342
|
-
"Assembly",
|
|
9343
|
-
"Other"
|
|
9344
|
-
]
|
|
9345
|
-
},
|
|
9346
|
-
"title": {
|
|
9347
|
-
"type": "string",
|
|
9348
|
-
"description": "Title",
|
|
9349
|
-
"enum": [
|
|
9350
|
-
"Dr.",
|
|
9351
|
-
"Prof.",
|
|
9352
|
-
"Prof. Dr."
|
|
9353
|
-
]
|
|
9354
|
-
},
|
|
9355
|
-
"first_name": {
|
|
9356
|
-
"type": "string",
|
|
9357
|
-
"description": "First Name"
|
|
9358
|
-
},
|
|
9359
|
-
"last_name": {
|
|
9360
|
-
"type": "string",
|
|
9361
|
-
"description": "Last Name"
|
|
9362
|
-
},
|
|
9363
|
-
"customer_number": {
|
|
9364
|
-
"type": "string",
|
|
9365
|
-
"description": "Customer Number"
|
|
9366
|
-
},
|
|
9367
|
-
"birthdate": {
|
|
9368
|
-
"type": "string",
|
|
9369
|
-
"format": "date",
|
|
9370
|
-
"description": "Date of Birth"
|
|
9371
|
-
},
|
|
9372
|
-
"email": {
|
|
9373
|
-
"type": "array",
|
|
9374
|
-
"description": "Email addresses",
|
|
9375
|
-
"items": {
|
|
9376
|
-
"type": "object",
|
|
9377
|
-
"properties": {
|
|
9378
|
-
"email": {
|
|
9379
|
-
"type": "string",
|
|
9380
|
-
"format": "email"
|
|
9381
|
-
},
|
|
9382
|
-
"_primary": {
|
|
9383
|
-
"type": "boolean"
|
|
9384
|
-
}
|
|
9385
|
-
}
|
|
9386
|
-
}
|
|
9387
|
-
},
|
|
9388
|
-
"phone": {
|
|
9389
|
-
"type": "array",
|
|
9390
|
-
"description": "Phone numbers",
|
|
9391
|
-
"items": {
|
|
9392
|
-
"type": "object",
|
|
9393
|
-
"properties": {
|
|
9394
|
-
"phone": {
|
|
9395
|
-
"type": "string"
|
|
9396
|
-
},
|
|
9397
|
-
"_primary": {
|
|
9398
|
-
"type": "boolean"
|
|
9399
|
-
}
|
|
9400
|
-
}
|
|
9401
|
-
}
|
|
9402
|
-
},
|
|
9403
|
-
"communication_preference": {
|
|
9404
|
-
"type": "string",
|
|
9405
|
-
"description": "Standard communication method",
|
|
9406
|
-
"enum": [
|
|
9407
|
-
"postal",
|
|
9408
|
-
"portal"
|
|
9409
|
-
]
|
|
9410
|
-
},
|
|
9411
|
-
"address": {
|
|
9412
|
-
"type": "array",
|
|
9413
|
-
"description": "Addresses",
|
|
9414
|
-
"items": {
|
|
9415
|
-
"type": "object",
|
|
9416
|
-
"properties": {
|
|
9417
|
-
"_primary": {
|
|
9418
|
-
"type": "boolean"
|
|
9419
|
-
},
|
|
9420
|
-
"postal_code": {
|
|
9421
|
-
"type": "string"
|
|
9422
|
-
},
|
|
9423
|
-
"city": {
|
|
9424
|
-
"type": "string"
|
|
9425
|
-
},
|
|
9426
|
-
"street": {
|
|
9427
|
-
"type": "string"
|
|
9428
|
-
},
|
|
9429
|
-
"street_number": {
|
|
9430
|
-
"type": "string"
|
|
9431
|
-
},
|
|
9432
|
-
"country": {
|
|
9433
|
-
"type": "string"
|
|
9434
|
-
}
|
|
9435
|
-
}
|
|
9436
|
-
}
|
|
9437
|
-
},
|
|
9438
|
-
"payment": {
|
|
9439
|
-
"type": "array",
|
|
9440
|
-
"description": "Payment methods",
|
|
9441
|
-
"items": {
|
|
9442
|
-
"type": "object",
|
|
9443
|
-
"properties": {
|
|
9444
|
-
"_primary": {
|
|
9445
|
-
"type": "boolean"
|
|
9446
|
-
}
|
|
9447
|
-
}
|
|
9448
|
-
}
|
|
9449
|
-
},
|
|
9450
|
-
"account": {
|
|
9451
|
-
"type": "array",
|
|
9452
|
-
"description": "Account relations",
|
|
9453
|
-
"items": {
|
|
9454
|
-
"type": "string"
|
|
9455
|
-
}
|
|
9456
|
-
},
|
|
9457
|
-
"marketing_permission": {
|
|
9458
|
-
"type": "boolean",
|
|
9459
|
-
"description": "Marketing Permission (deprecated)",
|
|
9460
|
-
"deprecated": true
|
|
9461
|
-
},
|
|
9462
|
-
"contact_owner": {
|
|
9463
|
-
"type": "string",
|
|
9464
|
-
"description": "Contact Owner user ID"
|
|
9465
|
-
},
|
|
9466
|
-
"consent_email_marketing": {
|
|
9467
|
-
"type": "object",
|
|
9468
|
-
"description": "Email Marketing consent"
|
|
9469
|
-
},
|
|
9470
|
-
"consent_sms_marketing": {
|
|
9471
|
-
"type": "object",
|
|
9472
|
-
"description": "SMS Marketing consent"
|
|
9473
|
-
},
|
|
9474
|
-
"consent_phone_call": {
|
|
9475
|
-
"type": "object",
|
|
9476
|
-
"description": "Direct Phone Marketing consent"
|
|
9477
|
-
},
|
|
9478
|
-
"consent_print_marketing": {
|
|
9479
|
-
"type": "object",
|
|
9480
|
-
"description": "Print Marketing consent"
|
|
9481
|
-
},
|
|
9482
|
-
"portal_users": {
|
|
9483
|
-
"type": "array",
|
|
9484
|
-
"description": "Portal Users relation",
|
|
9485
|
-
"items": {
|
|
9486
|
-
"type": "string"
|
|
9487
|
-
}
|
|
9488
|
-
},
|
|
9489
|
-
"opportunities": {
|
|
9490
|
-
"type": "array",
|
|
9491
|
-
"description": "Opportunities relation",
|
|
9492
|
-
"items": {
|
|
9493
|
-
"type": "string"
|
|
9494
|
-
}
|
|
9495
|
-
},
|
|
9496
|
-
"orders": {
|
|
9497
|
-
"type": "array",
|
|
9498
|
-
"description": "Orders relation",
|
|
9499
|
-
"items": {
|
|
9500
|
-
"type": "string"
|
|
9501
|
-
}
|
|
9502
|
-
},
|
|
9503
|
-
"contracts": {
|
|
9504
|
-
"type": "array",
|
|
9505
|
-
"description": "Contracts relation",
|
|
9506
|
-
"items": {
|
|
9507
|
-
"type": "string"
|
|
9508
|
-
}
|
|
9509
|
-
},
|
|
9510
|
-
"external_id": {
|
|
9511
|
-
"type": "string",
|
|
9512
|
-
"description": "External ID",
|
|
9513
|
-
"readOnly": true
|
|
9514
|
-
}
|
|
9515
|
-
}
|
|
9264
|
+
"additionalProperties": true
|
|
9516
9265
|
},
|
|
9517
9266
|
"availability_address": {
|
|
9518
9267
|
"type": "object",
|