@epilot/pricing-client 3.51.4 → 3.53.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/definition.js +1 -1
- package/dist/openapi.d.ts +320 -6
- package/dist/openapi.json +544 -27
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={
|
|
1
|
+
(()=>{"use strict";var e={330:function(e,r,t){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=i(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://pricing-api.sls.epilot.io"}],"paths":{"/v1/pricing:compute":{"post":{"operationId":"$calculatePricingDetails","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v1/order":{"post":{"operationId":"createOrder","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/order/{id}":{"put":{"operationId":"putOrder","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/cart:checkout":{"post":{"operationId":"$checkoutCart","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/catalog":{"post":{"operationId":"$searchCatalog","parameters":[{"in":"header","name":"X-Ivy-Org-ID"},{"in":"header","name":"Authorization"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/catalog":{"post":{"operationId":"$privateSearchCatalog","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/validate-promo-codes":{"post":{"operationId":"$validatePromoCodes","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/availability:check":{"post":{"operationId":"$availabilityCheck","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/validate-availability/{id}":{"get":{"operationId":"$validateAvailabilityFile","parameters":[{"in":"path","name":"id","required":true},{"in":"header","name":"X-Epilot-Org-ID","required":true}],"responses":{}}},"/v1/public/historicMarketPrices":{"get":{"operationId":"$historicMarketPrices","parameters":[{"in":"query","name":"market","required":true},{"in":"query","name":"bidding_zone","required":true},{"in":"query","name":"frequency","required":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true}],"responses":{}}},"/v1/public/averageMarketPrice":{"get":{"operationId":"$averageMarketPrice","parameters":[{"in":"query","name":"market","required":true},{"in":"query","name":"bidding_zone","required":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true}],"responses":{}}},"/v1/public/integration/{integrationId}/products":{"post":{"operationId":"$searchExternalProducts","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/products-recommendation":{"post":{"operationId":"$searchExternalProductsRecommendation","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/providers:search":{"post":{"operationId":"$searchProviders","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/streets:search":{"post":{"operationId":"$searchStreets","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/compute-price":{"post":{"operationId":"$computePrice","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/integration/{integrationId}/credentials":{"get":{"operationId":"$getCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"responses":{}}},"/v1/integration/{integrationId}/credentials:save":{"put":{"operationId":"$saveCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/integration/{integrationId}/credentials:delete":{"delete":{"operationId":"$deleteCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"responses":{}}},"/v1/public/external-catalog/products":{"post":{"operationId":"$getExternalCatalogProducts","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/external-catalog/products-recommendation":{"post":{"operationId":"$getExternalCatalogProductsRecommendation","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/product-recommendations":{"post":{"operationId":"$productRecommendations","parameters":[{"in":"header","name":"X-Ivy-Org-ID"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{}}')}},r={},t=function t(i){var n=r[i];if(void 0!==n)return n.exports;var a=r[i]={exports:{}};return e[i].call(a.exports,a,a.exports,t),a.exports}(330),i=exports;for(var n in t)i[n]=t[n];t.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -153,7 +153,7 @@ declare namespace Components {
|
|
|
153
153
|
/**
|
|
154
154
|
* The postal code for the address.
|
|
155
155
|
*/
|
|
156
|
-
postal_code
|
|
156
|
+
postal_code: string;
|
|
157
157
|
/**
|
|
158
158
|
* The name of the city, district, village, or town.
|
|
159
159
|
*/
|
|
@@ -164,7 +164,7 @@ declare namespace Components {
|
|
|
164
164
|
country?: string;
|
|
165
165
|
}
|
|
166
166
|
/**
|
|
167
|
-
* The availability check result payload
|
|
167
|
+
* The product availability check result payload
|
|
168
168
|
* example:
|
|
169
169
|
* {
|
|
170
170
|
* "available_products": [],
|
|
@@ -4587,6 +4587,18 @@ declare namespace Components {
|
|
|
4587
4587
|
origin: "journey";
|
|
4588
4588
|
context: JourneyContext;
|
|
4589
4589
|
}
|
|
4590
|
+
/**
|
|
4591
|
+
* The request payload for the external catalog service with a portal context.
|
|
4592
|
+
*/
|
|
4593
|
+
export interface ExternalCatalogPortalRequest {
|
|
4594
|
+
/**
|
|
4595
|
+
* The origin of the request.
|
|
4596
|
+
* example:
|
|
4597
|
+
* portal
|
|
4598
|
+
*/
|
|
4599
|
+
origin: "portal";
|
|
4600
|
+
context: PortalContext;
|
|
4601
|
+
}
|
|
4590
4602
|
/**
|
|
4591
4603
|
* The request payload for the external catalog service.
|
|
4592
4604
|
* example:
|
|
@@ -4692,7 +4704,7 @@ declare namespace Components {
|
|
|
4692
4704
|
* }
|
|
4693
4705
|
* }
|
|
4694
4706
|
*/
|
|
4695
|
-
/* The request payload for the external catalog service with a journey context. */ ExternalCatalogJourneyRequest | /* The request payload for the external catalog service with a custom context. E.g. for requests from the Portal. */ ExternalCatalogCustomRequest);
|
|
4707
|
+
/* The request payload for the external catalog service with a journey context. */ ExternalCatalogJourneyRequest | /* The request payload for the external catalog service with a portal context. */ ExternalCatalogPortalRequest | /* The request payload for the external catalog service with a custom context. E.g. for requests from the Portal. */ ExternalCatalogCustomRequest);
|
|
4696
4708
|
/**
|
|
4697
4709
|
* example:
|
|
4698
4710
|
* {
|
|
@@ -5436,9 +5448,11 @@ declare namespace Components {
|
|
|
5436
5448
|
base_url?: string;
|
|
5437
5449
|
}
|
|
5438
5450
|
export interface Offer {
|
|
5439
|
-
product_id?: string;
|
|
5440
|
-
price_id?: string;
|
|
5441
5451
|
target_id?: string;
|
|
5452
|
+
items?: {
|
|
5453
|
+
price_id: string;
|
|
5454
|
+
product_id: string;
|
|
5455
|
+
}[];
|
|
5442
5456
|
}
|
|
5443
5457
|
/**
|
|
5444
5458
|
* The opportunity entity
|
|
@@ -6387,6 +6401,10 @@ declare namespace Components {
|
|
|
6387
6401
|
prices?: {
|
|
6388
6402
|
$relation?: EntityRelation[];
|
|
6389
6403
|
};
|
|
6404
|
+
/**
|
|
6405
|
+
* The coupons referenced from within `line_items`
|
|
6406
|
+
*/
|
|
6407
|
+
coupons?: any[];
|
|
6390
6408
|
/**
|
|
6391
6409
|
* Total of all items before (discounts or) taxes are applied.
|
|
6392
6410
|
*/
|
|
@@ -6524,6 +6542,297 @@ declare namespace Components {
|
|
|
6524
6542
|
[name: string]: any;
|
|
6525
6543
|
};
|
|
6526
6544
|
}
|
|
6545
|
+
export interface PortalContext {
|
|
6546
|
+
/**
|
|
6547
|
+
* The contract information.
|
|
6548
|
+
*/
|
|
6549
|
+
contract: {
|
|
6550
|
+
/**
|
|
6551
|
+
* The unique identifier of the contract.
|
|
6552
|
+
*/
|
|
6553
|
+
_id?: string;
|
|
6554
|
+
/**
|
|
6555
|
+
* Contract Name
|
|
6556
|
+
*/
|
|
6557
|
+
contract_name?: string;
|
|
6558
|
+
/**
|
|
6559
|
+
* Contract Number
|
|
6560
|
+
*/
|
|
6561
|
+
contract_number?: string;
|
|
6562
|
+
/**
|
|
6563
|
+
* Assignee user ID
|
|
6564
|
+
*/
|
|
6565
|
+
assignee?: string;
|
|
6566
|
+
/**
|
|
6567
|
+
* Contract status
|
|
6568
|
+
*/
|
|
6569
|
+
status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired";
|
|
6570
|
+
/**
|
|
6571
|
+
* Description of the contract
|
|
6572
|
+
*/
|
|
6573
|
+
description?: string;
|
|
6574
|
+
/**
|
|
6575
|
+
* Billing Account relation ID
|
|
6576
|
+
*/
|
|
6577
|
+
billing_account?: string;
|
|
6578
|
+
/**
|
|
6579
|
+
* Account Number
|
|
6580
|
+
*/
|
|
6581
|
+
account_number?: string;
|
|
6582
|
+
/**
|
|
6583
|
+
* Branch/commodity type
|
|
6584
|
+
*/
|
|
6585
|
+
branch?: "power" | "gas" | "water" | "waste_water" | "district_heating";
|
|
6586
|
+
/**
|
|
6587
|
+
* Move In Date
|
|
6588
|
+
*/
|
|
6589
|
+
move_in_date?: string; // date
|
|
6590
|
+
/**
|
|
6591
|
+
* Move Out Date
|
|
6592
|
+
*/
|
|
6593
|
+
move_out_date?: string; // date
|
|
6594
|
+
/**
|
|
6595
|
+
* Billing Address
|
|
6596
|
+
*/
|
|
6597
|
+
billing_address?: {
|
|
6598
|
+
[key: string]: any;
|
|
6599
|
+
};
|
|
6600
|
+
/**
|
|
6601
|
+
* Delivery Address
|
|
6602
|
+
*/
|
|
6603
|
+
delivery_address?: {
|
|
6604
|
+
[key: string]: any;
|
|
6605
|
+
};
|
|
6606
|
+
/**
|
|
6607
|
+
* Additional Addresses
|
|
6608
|
+
*/
|
|
6609
|
+
additional_addresses?: {
|
|
6610
|
+
[key: string]: any;
|
|
6611
|
+
}[];
|
|
6612
|
+
/**
|
|
6613
|
+
* Date of Termination
|
|
6614
|
+
*/
|
|
6615
|
+
termination_date?: string; // date
|
|
6616
|
+
/**
|
|
6617
|
+
* Reason For Termination
|
|
6618
|
+
*/
|
|
6619
|
+
termination_reason?: string;
|
|
6620
|
+
/**
|
|
6621
|
+
* Start Date
|
|
6622
|
+
*/
|
|
6623
|
+
start_date?: string; // date
|
|
6624
|
+
/**
|
|
6625
|
+
* End Date
|
|
6626
|
+
*/
|
|
6627
|
+
end_date?: string; // date
|
|
6628
|
+
/**
|
|
6629
|
+
* Customer relation (contact or account)
|
|
6630
|
+
*/
|
|
6631
|
+
customer?: string[];
|
|
6632
|
+
/**
|
|
6633
|
+
* Order relation ID
|
|
6634
|
+
*/
|
|
6635
|
+
order?: string;
|
|
6636
|
+
/**
|
|
6637
|
+
* Contract type
|
|
6638
|
+
*/
|
|
6639
|
+
type?: "one_time" | "recurring";
|
|
6640
|
+
/**
|
|
6641
|
+
* Billing Period
|
|
6642
|
+
*/
|
|
6643
|
+
billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
|
|
6644
|
+
/**
|
|
6645
|
+
* Billing Duration amount
|
|
6646
|
+
*/
|
|
6647
|
+
billing_duration_amount?: number;
|
|
6648
|
+
/**
|
|
6649
|
+
* Billing Duration Unit
|
|
6650
|
+
*/
|
|
6651
|
+
billing_duration_unit?: "weeks" | "months" | "years";
|
|
6652
|
+
/**
|
|
6653
|
+
* Notice Time amount
|
|
6654
|
+
*/
|
|
6655
|
+
notice_time_amount?: number;
|
|
6656
|
+
/**
|
|
6657
|
+
* Notice Time Unit
|
|
6658
|
+
*/
|
|
6659
|
+
notice_time_unit?: "weeks" | "months" | "years";
|
|
6660
|
+
/**
|
|
6661
|
+
* Termination Time amount
|
|
6662
|
+
*/
|
|
6663
|
+
termination_time_amount?: number;
|
|
6664
|
+
/**
|
|
6665
|
+
* Termination Time Unit
|
|
6666
|
+
*/
|
|
6667
|
+
termination_time_unit?: "weeks" | "months" | "years";
|
|
6668
|
+
/**
|
|
6669
|
+
* Renewal Duration amount
|
|
6670
|
+
*/
|
|
6671
|
+
renewal_duration_amount?: number;
|
|
6672
|
+
/**
|
|
6673
|
+
* Renewal Duration Unit
|
|
6674
|
+
*/
|
|
6675
|
+
renewal_duration_unit?: "weeks" | "months" | "years";
|
|
6676
|
+
/**
|
|
6677
|
+
* Billing Due Day
|
|
6678
|
+
*/
|
|
6679
|
+
billing_due_day?: number;
|
|
6680
|
+
/**
|
|
6681
|
+
* Installment Amount
|
|
6682
|
+
*/
|
|
6683
|
+
installment_amount?: {
|
|
6684
|
+
value?: number;
|
|
6685
|
+
currency?: string;
|
|
6686
|
+
};
|
|
6687
|
+
/**
|
|
6688
|
+
* Balance
|
|
6689
|
+
*/
|
|
6690
|
+
balance?: {
|
|
6691
|
+
value?: number;
|
|
6692
|
+
currency?: string;
|
|
6693
|
+
};
|
|
6694
|
+
/**
|
|
6695
|
+
* Meters relation
|
|
6696
|
+
*/
|
|
6697
|
+
meters?: string[];
|
|
6698
|
+
/**
|
|
6699
|
+
* Payment Details relation ID
|
|
6700
|
+
*/
|
|
6701
|
+
payment?: string;
|
|
6702
|
+
/**
|
|
6703
|
+
* Last Sync At
|
|
6704
|
+
*/
|
|
6705
|
+
last_sync_at?: string; // date
|
|
6706
|
+
/**
|
|
6707
|
+
* External ID
|
|
6708
|
+
*/
|
|
6709
|
+
external_id?: string;
|
|
6710
|
+
};
|
|
6711
|
+
/**
|
|
6712
|
+
* The contact information.
|
|
6713
|
+
*/
|
|
6714
|
+
contact: {
|
|
6715
|
+
/**
|
|
6716
|
+
* The unique identifier of the contact.
|
|
6717
|
+
*/
|
|
6718
|
+
_id?: string;
|
|
6719
|
+
/**
|
|
6720
|
+
* Salutation
|
|
6721
|
+
*/
|
|
6722
|
+
salutation?: "Mr." | "Ms. / Mrs." | "Company" | "Contact Person" | "Company/Contact Person" | "Spouse" | "Family" | "Ownership" | "Assembly" | "Other";
|
|
6723
|
+
/**
|
|
6724
|
+
* Title
|
|
6725
|
+
*/
|
|
6726
|
+
title?: "Dr." | "Prof." | "Prof. Dr.";
|
|
6727
|
+
/**
|
|
6728
|
+
* First Name
|
|
6729
|
+
*/
|
|
6730
|
+
first_name?: string;
|
|
6731
|
+
/**
|
|
6732
|
+
* Last Name
|
|
6733
|
+
*/
|
|
6734
|
+
last_name?: string;
|
|
6735
|
+
/**
|
|
6736
|
+
* Customer Number
|
|
6737
|
+
*/
|
|
6738
|
+
customer_number?: string;
|
|
6739
|
+
/**
|
|
6740
|
+
* Date of Birth
|
|
6741
|
+
*/
|
|
6742
|
+
birthdate?: string; // date
|
|
6743
|
+
/**
|
|
6744
|
+
* Email addresses
|
|
6745
|
+
*/
|
|
6746
|
+
email?: {
|
|
6747
|
+
email?: string; // email
|
|
6748
|
+
_primary?: boolean;
|
|
6749
|
+
}[];
|
|
6750
|
+
/**
|
|
6751
|
+
* Phone numbers
|
|
6752
|
+
*/
|
|
6753
|
+
phone?: {
|
|
6754
|
+
phone?: string;
|
|
6755
|
+
_primary?: boolean;
|
|
6756
|
+
}[];
|
|
6757
|
+
/**
|
|
6758
|
+
* Standard communication method
|
|
6759
|
+
*/
|
|
6760
|
+
communication_preference?: "postal" | "portal";
|
|
6761
|
+
/**
|
|
6762
|
+
* Addresses
|
|
6763
|
+
*/
|
|
6764
|
+
address?: {
|
|
6765
|
+
_primary?: boolean;
|
|
6766
|
+
postal_code?: string;
|
|
6767
|
+
city?: string;
|
|
6768
|
+
street?: string;
|
|
6769
|
+
street_number?: string;
|
|
6770
|
+
country?: string;
|
|
6771
|
+
}[];
|
|
6772
|
+
/**
|
|
6773
|
+
* Payment methods
|
|
6774
|
+
*/
|
|
6775
|
+
payment?: {
|
|
6776
|
+
_primary?: boolean;
|
|
6777
|
+
}[];
|
|
6778
|
+
/**
|
|
6779
|
+
* Account relations
|
|
6780
|
+
*/
|
|
6781
|
+
account?: string[];
|
|
6782
|
+
/**
|
|
6783
|
+
* Marketing Permission (deprecated)
|
|
6784
|
+
*/
|
|
6785
|
+
marketing_permission?: boolean;
|
|
6786
|
+
/**
|
|
6787
|
+
* Contact Owner user ID
|
|
6788
|
+
*/
|
|
6789
|
+
contact_owner?: string;
|
|
6790
|
+
/**
|
|
6791
|
+
* Email Marketing consent
|
|
6792
|
+
*/
|
|
6793
|
+
consent_email_marketing?: {
|
|
6794
|
+
[key: string]: any;
|
|
6795
|
+
};
|
|
6796
|
+
/**
|
|
6797
|
+
* SMS Marketing consent
|
|
6798
|
+
*/
|
|
6799
|
+
consent_sms_marketing?: {
|
|
6800
|
+
[key: string]: any;
|
|
6801
|
+
};
|
|
6802
|
+
/**
|
|
6803
|
+
* Direct Phone Marketing consent
|
|
6804
|
+
*/
|
|
6805
|
+
consent_phone_call?: {
|
|
6806
|
+
[key: string]: any;
|
|
6807
|
+
};
|
|
6808
|
+
/**
|
|
6809
|
+
* Print Marketing consent
|
|
6810
|
+
*/
|
|
6811
|
+
consent_print_marketing?: {
|
|
6812
|
+
[key: string]: any;
|
|
6813
|
+
};
|
|
6814
|
+
/**
|
|
6815
|
+
* Portal Users relation
|
|
6816
|
+
*/
|
|
6817
|
+
portal_users?: string[];
|
|
6818
|
+
/**
|
|
6819
|
+
* Opportunities relation
|
|
6820
|
+
*/
|
|
6821
|
+
opportunities?: string[];
|
|
6822
|
+
/**
|
|
6823
|
+
* Orders relation
|
|
6824
|
+
*/
|
|
6825
|
+
orders?: string[];
|
|
6826
|
+
/**
|
|
6827
|
+
* Contracts relation
|
|
6828
|
+
*/
|
|
6829
|
+
contracts?: string[];
|
|
6830
|
+
/**
|
|
6831
|
+
* External ID
|
|
6832
|
+
*/
|
|
6833
|
+
external_id?: string;
|
|
6834
|
+
};
|
|
6835
|
+
}
|
|
6527
6836
|
/**
|
|
6528
6837
|
* The meter type for power
|
|
6529
6838
|
*/
|
|
@@ -8933,6 +9242,7 @@ declare namespace Components {
|
|
|
8933
9242
|
* The contract id to be used as source for the recommendation
|
|
8934
9243
|
*/
|
|
8935
9244
|
contract_id?: string;
|
|
9245
|
+
filters?: /* Availability filters dimensions */ AvailabilityFilters;
|
|
8936
9246
|
}
|
|
8937
9247
|
/**
|
|
8938
9248
|
* example:
|
|
@@ -9589,7 +9899,7 @@ declare namespace Paths {
|
|
|
9589
9899
|
export type RequestBody = /* Availability check request payload */ Components.Schemas.AvailabilityCheckParams;
|
|
9590
9900
|
namespace Responses {
|
|
9591
9901
|
export type $200 = /**
|
|
9592
|
-
* The availability check result payload
|
|
9902
|
+
* The product availability check result payload
|
|
9593
9903
|
* example:
|
|
9594
9904
|
* {
|
|
9595
9905
|
* "available_products": [],
|
|
@@ -9625,6 +9935,7 @@ declare namespace Paths {
|
|
|
9625
9935
|
namespace Responses {
|
|
9626
9936
|
export type $200 = Components.Schemas.AverageMarketPriceResult;
|
|
9627
9937
|
export type $400 = Components.Schemas.Error;
|
|
9938
|
+
export type $404 = Components.Schemas.Error;
|
|
9628
9939
|
}
|
|
9629
9940
|
}
|
|
9630
9941
|
namespace $CalculatePricingDetails {
|
|
@@ -9812,6 +10123,7 @@ declare namespace Paths {
|
|
|
9812
10123
|
namespace Responses {
|
|
9813
10124
|
export type $200 = Components.Schemas.HistoricMarketPricesResult;
|
|
9814
10125
|
export type $400 = Components.Schemas.Error;
|
|
10126
|
+
export type $404 = Components.Schemas.Error;
|
|
9815
10127
|
}
|
|
9816
10128
|
}
|
|
9817
10129
|
namespace $PrivateSearchCatalog {
|
|
@@ -11743,6 +12055,7 @@ export type ExternalCatalogConfigurationRequest = Components.Schemas.ExternalCat
|
|
|
11743
12055
|
export type ExternalCatalogCustomRequest = Components.Schemas.ExternalCatalogCustomRequest;
|
|
11744
12056
|
export type ExternalCatalogItem = Components.Schemas.ExternalCatalogItem;
|
|
11745
12057
|
export type ExternalCatalogJourneyRequest = Components.Schemas.ExternalCatalogJourneyRequest;
|
|
12058
|
+
export type ExternalCatalogPortalRequest = Components.Schemas.ExternalCatalogPortalRequest;
|
|
11746
12059
|
export type ExternalCatalogRequest = Components.Schemas.ExternalCatalogRequest;
|
|
11747
12060
|
export type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping;
|
|
11748
12061
|
export type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings;
|
|
@@ -11771,6 +12084,7 @@ export type OrderRelation = Components.Schemas.OrderRelation;
|
|
|
11771
12084
|
export type OrderSource = Components.Schemas.OrderSource;
|
|
11772
12085
|
export type OrderStatus = Components.Schemas.OrderStatus;
|
|
11773
12086
|
export type PaymentMethod = Components.Schemas.PaymentMethod;
|
|
12087
|
+
export type PortalContext = Components.Schemas.PortalContext;
|
|
11774
12088
|
export type PowerMeterType = Components.Schemas.PowerMeterType;
|
|
11775
12089
|
export type Price = Components.Schemas.Price;
|
|
11776
12090
|
export type PriceAmounts = Components.Schemas.PriceAmounts;
|
package/dist/openapi.json
CHANGED
|
@@ -94,6 +94,7 @@
|
|
|
94
94
|
"Spot Market API",
|
|
95
95
|
"Availability API",
|
|
96
96
|
"External Integrations API",
|
|
97
|
+
"External Catalog API",
|
|
97
98
|
"Product Recommendations API",
|
|
98
99
|
"Promo Codes API"
|
|
99
100
|
]
|
|
@@ -129,8 +130,7 @@
|
|
|
129
130
|
"servers": [
|
|
130
131
|
{
|
|
131
132
|
"url": "https://pricing-api.sls.epilot.io"
|
|
132
|
-
}
|
|
133
|
-
null
|
|
133
|
+
}
|
|
134
134
|
],
|
|
135
135
|
"paths": {
|
|
136
136
|
"/v1/pricing:compute": {
|
|
@@ -1330,22 +1330,6 @@
|
|
|
1330
1330
|
}
|
|
1331
1331
|
}
|
|
1332
1332
|
}
|
|
1333
|
-
},
|
|
1334
|
-
"Check availability with location & available date dimension": {
|
|
1335
|
-
"value": {
|
|
1336
|
-
"products": [
|
|
1337
|
-
"cd75456a-30e4-4912-95be-e743d5ea175b"
|
|
1338
|
-
],
|
|
1339
|
-
"filters": {
|
|
1340
|
-
"location": {
|
|
1341
|
-
"postal_code": "57008",
|
|
1342
|
-
"city": "Cologne",
|
|
1343
|
-
"street": "Media Park",
|
|
1344
|
-
"street_number": "8a"
|
|
1345
|
-
},
|
|
1346
|
-
"available_date": "2022-05-01"
|
|
1347
|
-
}
|
|
1348
|
-
}
|
|
1349
1333
|
}
|
|
1350
1334
|
}
|
|
1351
1335
|
}
|
|
@@ -1591,6 +1575,16 @@
|
|
|
1591
1575
|
}
|
|
1592
1576
|
}
|
|
1593
1577
|
}
|
|
1578
|
+
},
|
|
1579
|
+
"404": {
|
|
1580
|
+
"description": "No prices for date range found",
|
|
1581
|
+
"content": {
|
|
1582
|
+
"application/json": {
|
|
1583
|
+
"schema": {
|
|
1584
|
+
"$ref": "#/components/schemas/Error"
|
|
1585
|
+
}
|
|
1586
|
+
}
|
|
1587
|
+
}
|
|
1594
1588
|
}
|
|
1595
1589
|
}
|
|
1596
1590
|
}
|
|
@@ -1682,6 +1676,16 @@
|
|
|
1682
1676
|
}
|
|
1683
1677
|
}
|
|
1684
1678
|
}
|
|
1679
|
+
},
|
|
1680
|
+
"404": {
|
|
1681
|
+
"description": "No prices for date range found",
|
|
1682
|
+
"content": {
|
|
1683
|
+
"application/json": {
|
|
1684
|
+
"schema": {
|
|
1685
|
+
"$ref": "#/components/schemas/Error"
|
|
1686
|
+
}
|
|
1687
|
+
}
|
|
1688
|
+
}
|
|
1685
1689
|
}
|
|
1686
1690
|
}
|
|
1687
1691
|
}
|
|
@@ -3222,10 +3226,23 @@
|
|
|
3222
3226
|
"Search product recommendations by id": {
|
|
3223
3227
|
"value": {
|
|
3224
3228
|
"product_recommendation_ids": [
|
|
3225
|
-
"
|
|
3229
|
+
"22c134b7-8dd8-4872-a5c1-8fc6dd4ac2ee"
|
|
3226
3230
|
]
|
|
3227
3231
|
}
|
|
3228
3232
|
},
|
|
3233
|
+
"Search product recommendations by id with location filter": {
|
|
3234
|
+
"value": {
|
|
3235
|
+
"product_recommendation_ids": [
|
|
3236
|
+
"22c134b7-8dd8-4872-a5c1-8fc6dd4ac2ee"
|
|
3237
|
+
],
|
|
3238
|
+
"filters": {
|
|
3239
|
+
"location": {
|
|
3240
|
+
"postal_code": "50670",
|
|
3241
|
+
"city": "Köln"
|
|
3242
|
+
}
|
|
3243
|
+
}
|
|
3244
|
+
}
|
|
3245
|
+
},
|
|
3229
3246
|
"Search product recommendations by source product and price": {
|
|
3230
3247
|
"value": {
|
|
3231
3248
|
"catalog_item": {
|
|
@@ -4612,6 +4629,18 @@
|
|
|
4612
4629
|
}
|
|
4613
4630
|
}
|
|
4614
4631
|
},
|
|
4632
|
+
"coupons": {
|
|
4633
|
+
"type": "array",
|
|
4634
|
+
"description": "The coupons referenced from within `line_items`",
|
|
4635
|
+
"properties": {
|
|
4636
|
+
"$relation": {
|
|
4637
|
+
"type": "array",
|
|
4638
|
+
"items": {
|
|
4639
|
+
"$ref": "#/components/schemas/EntityRelation"
|
|
4640
|
+
}
|
|
4641
|
+
}
|
|
4642
|
+
}
|
|
4643
|
+
},
|
|
4615
4644
|
"amount_subtotal": {
|
|
4616
4645
|
"readOnly": true,
|
|
4617
4646
|
"type": "integer",
|
|
@@ -5586,7 +5615,7 @@
|
|
|
5586
5615
|
]
|
|
5587
5616
|
},
|
|
5588
5617
|
"AvailabilityResult": {
|
|
5589
|
-
"description": "The availability check result payload",
|
|
5618
|
+
"description": "The product availability check result payload",
|
|
5590
5619
|
"type": "object",
|
|
5591
5620
|
"properties": {
|
|
5592
5621
|
"available_products": {
|
|
@@ -7750,7 +7779,10 @@
|
|
|
7750
7779
|
"type": "string",
|
|
7751
7780
|
"description": "The name of the country."
|
|
7752
7781
|
}
|
|
7753
|
-
}
|
|
7782
|
+
},
|
|
7783
|
+
"required": [
|
|
7784
|
+
"postal_code"
|
|
7785
|
+
]
|
|
7754
7786
|
},
|
|
7755
7787
|
"AvailabilityFilters": {
|
|
7756
7788
|
"description": "Availability filters dimensions",
|
|
@@ -8779,6 +8811,9 @@
|
|
|
8779
8811
|
{
|
|
8780
8812
|
"$ref": "#/components/schemas/ExternalCatalogJourneyRequest"
|
|
8781
8813
|
},
|
|
8814
|
+
{
|
|
8815
|
+
"$ref": "#/components/schemas/ExternalCatalogPortalRequest"
|
|
8816
|
+
},
|
|
8782
8817
|
{
|
|
8783
8818
|
"$ref": "#/components/schemas/ExternalCatalogCustomRequest"
|
|
8784
8819
|
}
|
|
@@ -8789,6 +8824,7 @@
|
|
|
8789
8824
|
"propertyName": "origin",
|
|
8790
8825
|
"mapping": {
|
|
8791
8826
|
"journey": "#/components/schemas/ExternalCatalogJourneyRequest",
|
|
8827
|
+
"portal": "#/components/schemas/ExternalCatalogPortalRequest",
|
|
8792
8828
|
"custom": "#/components/schemas/ExternalCatalogCustomRequest"
|
|
8793
8829
|
}
|
|
8794
8830
|
},
|
|
@@ -8889,6 +8925,27 @@
|
|
|
8889
8925
|
"context"
|
|
8890
8926
|
]
|
|
8891
8927
|
},
|
|
8928
|
+
"ExternalCatalogPortalRequest": {
|
|
8929
|
+
"type": "object",
|
|
8930
|
+
"description": "The request payload for the external catalog service with a portal context.",
|
|
8931
|
+
"properties": {
|
|
8932
|
+
"origin": {
|
|
8933
|
+
"type": "string",
|
|
8934
|
+
"description": "The origin of the request.",
|
|
8935
|
+
"enum": [
|
|
8936
|
+
"portal"
|
|
8937
|
+
],
|
|
8938
|
+
"example": "portal"
|
|
8939
|
+
},
|
|
8940
|
+
"context": {
|
|
8941
|
+
"$ref": "#/components/schemas/PortalContext"
|
|
8942
|
+
}
|
|
8943
|
+
},
|
|
8944
|
+
"required": [
|
|
8945
|
+
"origin",
|
|
8946
|
+
"context"
|
|
8947
|
+
]
|
|
8948
|
+
},
|
|
8892
8949
|
"ExternalCatalogCustomRequest": {
|
|
8893
8950
|
"type": "object",
|
|
8894
8951
|
"description": "The request payload for the external catalog service with a custom context. E.g. for requests from the Portal.",
|
|
@@ -9005,6 +9062,451 @@
|
|
|
9005
9062
|
"steps_data"
|
|
9006
9063
|
]
|
|
9007
9064
|
},
|
|
9065
|
+
"PortalContext": {
|
|
9066
|
+
"type": "object",
|
|
9067
|
+
"additionalProperties": false,
|
|
9068
|
+
"properties": {
|
|
9069
|
+
"contract": {
|
|
9070
|
+
"type": "object",
|
|
9071
|
+
"description": "The contract information.",
|
|
9072
|
+
"properties": {
|
|
9073
|
+
"_id": {
|
|
9074
|
+
"type": "string",
|
|
9075
|
+
"description": "The unique identifier of the contract."
|
|
9076
|
+
},
|
|
9077
|
+
"contract_name": {
|
|
9078
|
+
"type": "string",
|
|
9079
|
+
"description": "Contract Name"
|
|
9080
|
+
},
|
|
9081
|
+
"contract_number": {
|
|
9082
|
+
"type": "string",
|
|
9083
|
+
"description": "Contract Number"
|
|
9084
|
+
},
|
|
9085
|
+
"assignee": {
|
|
9086
|
+
"type": "string",
|
|
9087
|
+
"description": "Assignee user ID"
|
|
9088
|
+
},
|
|
9089
|
+
"status": {
|
|
9090
|
+
"type": "string",
|
|
9091
|
+
"description": "Contract status",
|
|
9092
|
+
"enum": [
|
|
9093
|
+
"draft",
|
|
9094
|
+
"in_approval_process",
|
|
9095
|
+
"approved",
|
|
9096
|
+
"active",
|
|
9097
|
+
"deactivated",
|
|
9098
|
+
"revoked",
|
|
9099
|
+
"terminated",
|
|
9100
|
+
"expired"
|
|
9101
|
+
]
|
|
9102
|
+
},
|
|
9103
|
+
"description": {
|
|
9104
|
+
"type": "string",
|
|
9105
|
+
"description": "Description of the contract"
|
|
9106
|
+
},
|
|
9107
|
+
"billing_account": {
|
|
9108
|
+
"type": "string",
|
|
9109
|
+
"description": "Billing Account relation ID"
|
|
9110
|
+
},
|
|
9111
|
+
"account_number": {
|
|
9112
|
+
"type": "string",
|
|
9113
|
+
"description": "Account Number"
|
|
9114
|
+
},
|
|
9115
|
+
"branch": {
|
|
9116
|
+
"type": "string",
|
|
9117
|
+
"description": "Branch/commodity type",
|
|
9118
|
+
"enum": [
|
|
9119
|
+
"power",
|
|
9120
|
+
"gas",
|
|
9121
|
+
"water",
|
|
9122
|
+
"waste_water",
|
|
9123
|
+
"district_heating"
|
|
9124
|
+
]
|
|
9125
|
+
},
|
|
9126
|
+
"move_in_date": {
|
|
9127
|
+
"type": "string",
|
|
9128
|
+
"format": "date",
|
|
9129
|
+
"description": "Move In Date"
|
|
9130
|
+
},
|
|
9131
|
+
"move_out_date": {
|
|
9132
|
+
"type": "string",
|
|
9133
|
+
"format": "date",
|
|
9134
|
+
"description": "Move Out Date"
|
|
9135
|
+
},
|
|
9136
|
+
"billing_address": {
|
|
9137
|
+
"type": "object",
|
|
9138
|
+
"description": "Billing Address"
|
|
9139
|
+
},
|
|
9140
|
+
"delivery_address": {
|
|
9141
|
+
"type": "object",
|
|
9142
|
+
"description": "Delivery Address"
|
|
9143
|
+
},
|
|
9144
|
+
"additional_addresses": {
|
|
9145
|
+
"type": "array",
|
|
9146
|
+
"description": "Additional Addresses",
|
|
9147
|
+
"items": {
|
|
9148
|
+
"type": "object"
|
|
9149
|
+
}
|
|
9150
|
+
},
|
|
9151
|
+
"termination_date": {
|
|
9152
|
+
"type": "string",
|
|
9153
|
+
"format": "date",
|
|
9154
|
+
"description": "Date of Termination"
|
|
9155
|
+
},
|
|
9156
|
+
"termination_reason": {
|
|
9157
|
+
"type": "string",
|
|
9158
|
+
"description": "Reason For Termination"
|
|
9159
|
+
},
|
|
9160
|
+
"start_date": {
|
|
9161
|
+
"type": "string",
|
|
9162
|
+
"format": "date",
|
|
9163
|
+
"description": "Start Date"
|
|
9164
|
+
},
|
|
9165
|
+
"end_date": {
|
|
9166
|
+
"type": "string",
|
|
9167
|
+
"format": "date",
|
|
9168
|
+
"description": "End Date"
|
|
9169
|
+
},
|
|
9170
|
+
"customer": {
|
|
9171
|
+
"type": "array",
|
|
9172
|
+
"description": "Customer relation (contact or account)",
|
|
9173
|
+
"items": {
|
|
9174
|
+
"type": "string"
|
|
9175
|
+
}
|
|
9176
|
+
},
|
|
9177
|
+
"order": {
|
|
9178
|
+
"type": "string",
|
|
9179
|
+
"description": "Order relation ID"
|
|
9180
|
+
},
|
|
9181
|
+
"type": {
|
|
9182
|
+
"type": "string",
|
|
9183
|
+
"description": "Contract type",
|
|
9184
|
+
"enum": [
|
|
9185
|
+
"one_time",
|
|
9186
|
+
"recurring"
|
|
9187
|
+
]
|
|
9188
|
+
},
|
|
9189
|
+
"billing_period": {
|
|
9190
|
+
"type": "string",
|
|
9191
|
+
"description": "Billing Period",
|
|
9192
|
+
"enum": [
|
|
9193
|
+
"weekly",
|
|
9194
|
+
"monthly",
|
|
9195
|
+
"every_quarter",
|
|
9196
|
+
"every_6_months",
|
|
9197
|
+
"yearly"
|
|
9198
|
+
]
|
|
9199
|
+
},
|
|
9200
|
+
"billing_duration_amount": {
|
|
9201
|
+
"type": "number",
|
|
9202
|
+
"description": "Billing Duration amount",
|
|
9203
|
+
"minimum": 0
|
|
9204
|
+
},
|
|
9205
|
+
"billing_duration_unit": {
|
|
9206
|
+
"type": "string",
|
|
9207
|
+
"description": "Billing Duration Unit",
|
|
9208
|
+
"enum": [
|
|
9209
|
+
"weeks",
|
|
9210
|
+
"months",
|
|
9211
|
+
"years"
|
|
9212
|
+
]
|
|
9213
|
+
},
|
|
9214
|
+
"notice_time_amount": {
|
|
9215
|
+
"type": "number",
|
|
9216
|
+
"description": "Notice Time amount",
|
|
9217
|
+
"minimum": 0
|
|
9218
|
+
},
|
|
9219
|
+
"notice_time_unit": {
|
|
9220
|
+
"type": "string",
|
|
9221
|
+
"description": "Notice Time Unit",
|
|
9222
|
+
"enum": [
|
|
9223
|
+
"weeks",
|
|
9224
|
+
"months",
|
|
9225
|
+
"years"
|
|
9226
|
+
]
|
|
9227
|
+
},
|
|
9228
|
+
"termination_time_amount": {
|
|
9229
|
+
"type": "number",
|
|
9230
|
+
"description": "Termination Time amount",
|
|
9231
|
+
"minimum": 0
|
|
9232
|
+
},
|
|
9233
|
+
"termination_time_unit": {
|
|
9234
|
+
"type": "string",
|
|
9235
|
+
"description": "Termination Time Unit",
|
|
9236
|
+
"enum": [
|
|
9237
|
+
"weeks",
|
|
9238
|
+
"months",
|
|
9239
|
+
"years"
|
|
9240
|
+
]
|
|
9241
|
+
},
|
|
9242
|
+
"renewal_duration_amount": {
|
|
9243
|
+
"type": "number",
|
|
9244
|
+
"description": "Renewal Duration amount",
|
|
9245
|
+
"minimum": 0
|
|
9246
|
+
},
|
|
9247
|
+
"renewal_duration_unit": {
|
|
9248
|
+
"type": "string",
|
|
9249
|
+
"description": "Renewal Duration Unit",
|
|
9250
|
+
"enum": [
|
|
9251
|
+
"weeks",
|
|
9252
|
+
"months",
|
|
9253
|
+
"years"
|
|
9254
|
+
]
|
|
9255
|
+
},
|
|
9256
|
+
"billing_due_day": {
|
|
9257
|
+
"type": "number",
|
|
9258
|
+
"description": "Billing Due Day"
|
|
9259
|
+
},
|
|
9260
|
+
"installment_amount": {
|
|
9261
|
+
"type": "object",
|
|
9262
|
+
"description": "Installment Amount",
|
|
9263
|
+
"properties": {
|
|
9264
|
+
"value": {
|
|
9265
|
+
"type": "number"
|
|
9266
|
+
},
|
|
9267
|
+
"currency": {
|
|
9268
|
+
"type": "string",
|
|
9269
|
+
"default": "EUR"
|
|
9270
|
+
}
|
|
9271
|
+
}
|
|
9272
|
+
},
|
|
9273
|
+
"balance": {
|
|
9274
|
+
"type": "object",
|
|
9275
|
+
"description": "Balance",
|
|
9276
|
+
"properties": {
|
|
9277
|
+
"value": {
|
|
9278
|
+
"type": "number"
|
|
9279
|
+
},
|
|
9280
|
+
"currency": {
|
|
9281
|
+
"type": "string",
|
|
9282
|
+
"default": "EUR"
|
|
9283
|
+
}
|
|
9284
|
+
}
|
|
9285
|
+
},
|
|
9286
|
+
"meters": {
|
|
9287
|
+
"type": "array",
|
|
9288
|
+
"description": "Meters relation",
|
|
9289
|
+
"items": {
|
|
9290
|
+
"type": "string"
|
|
9291
|
+
}
|
|
9292
|
+
},
|
|
9293
|
+
"payment": {
|
|
9294
|
+
"type": "string",
|
|
9295
|
+
"description": "Payment Details relation ID"
|
|
9296
|
+
},
|
|
9297
|
+
"last_sync_at": {
|
|
9298
|
+
"type": "string",
|
|
9299
|
+
"format": "date",
|
|
9300
|
+
"description": "Last Sync At"
|
|
9301
|
+
},
|
|
9302
|
+
"external_id": {
|
|
9303
|
+
"type": "string",
|
|
9304
|
+
"description": "External ID",
|
|
9305
|
+
"readOnly": true
|
|
9306
|
+
}
|
|
9307
|
+
}
|
|
9308
|
+
},
|
|
9309
|
+
"contact": {
|
|
9310
|
+
"type": "object",
|
|
9311
|
+
"description": "The contact information.",
|
|
9312
|
+
"properties": {
|
|
9313
|
+
"_id": {
|
|
9314
|
+
"type": "string",
|
|
9315
|
+
"description": "The unique identifier of the contact."
|
|
9316
|
+
},
|
|
9317
|
+
"salutation": {
|
|
9318
|
+
"type": "string",
|
|
9319
|
+
"description": "Salutation",
|
|
9320
|
+
"enum": [
|
|
9321
|
+
"Mr.",
|
|
9322
|
+
"Ms. / Mrs.",
|
|
9323
|
+
"Company",
|
|
9324
|
+
"Contact Person",
|
|
9325
|
+
"Company/Contact Person",
|
|
9326
|
+
"Spouse",
|
|
9327
|
+
"Family",
|
|
9328
|
+
"Ownership",
|
|
9329
|
+
"Assembly",
|
|
9330
|
+
"Other"
|
|
9331
|
+
]
|
|
9332
|
+
},
|
|
9333
|
+
"title": {
|
|
9334
|
+
"type": "string",
|
|
9335
|
+
"description": "Title",
|
|
9336
|
+
"enum": [
|
|
9337
|
+
"Dr.",
|
|
9338
|
+
"Prof.",
|
|
9339
|
+
"Prof. Dr."
|
|
9340
|
+
]
|
|
9341
|
+
},
|
|
9342
|
+
"first_name": {
|
|
9343
|
+
"type": "string",
|
|
9344
|
+
"description": "First Name"
|
|
9345
|
+
},
|
|
9346
|
+
"last_name": {
|
|
9347
|
+
"type": "string",
|
|
9348
|
+
"description": "Last Name"
|
|
9349
|
+
},
|
|
9350
|
+
"customer_number": {
|
|
9351
|
+
"type": "string",
|
|
9352
|
+
"description": "Customer Number"
|
|
9353
|
+
},
|
|
9354
|
+
"birthdate": {
|
|
9355
|
+
"type": "string",
|
|
9356
|
+
"format": "date",
|
|
9357
|
+
"description": "Date of Birth"
|
|
9358
|
+
},
|
|
9359
|
+
"email": {
|
|
9360
|
+
"type": "array",
|
|
9361
|
+
"description": "Email addresses",
|
|
9362
|
+
"items": {
|
|
9363
|
+
"type": "object",
|
|
9364
|
+
"properties": {
|
|
9365
|
+
"email": {
|
|
9366
|
+
"type": "string",
|
|
9367
|
+
"format": "email"
|
|
9368
|
+
},
|
|
9369
|
+
"_primary": {
|
|
9370
|
+
"type": "boolean"
|
|
9371
|
+
}
|
|
9372
|
+
}
|
|
9373
|
+
}
|
|
9374
|
+
},
|
|
9375
|
+
"phone": {
|
|
9376
|
+
"type": "array",
|
|
9377
|
+
"description": "Phone numbers",
|
|
9378
|
+
"items": {
|
|
9379
|
+
"type": "object",
|
|
9380
|
+
"properties": {
|
|
9381
|
+
"phone": {
|
|
9382
|
+
"type": "string"
|
|
9383
|
+
},
|
|
9384
|
+
"_primary": {
|
|
9385
|
+
"type": "boolean"
|
|
9386
|
+
}
|
|
9387
|
+
}
|
|
9388
|
+
}
|
|
9389
|
+
},
|
|
9390
|
+
"communication_preference": {
|
|
9391
|
+
"type": "string",
|
|
9392
|
+
"description": "Standard communication method",
|
|
9393
|
+
"enum": [
|
|
9394
|
+
"postal",
|
|
9395
|
+
"portal"
|
|
9396
|
+
]
|
|
9397
|
+
},
|
|
9398
|
+
"address": {
|
|
9399
|
+
"type": "array",
|
|
9400
|
+
"description": "Addresses",
|
|
9401
|
+
"items": {
|
|
9402
|
+
"type": "object",
|
|
9403
|
+
"properties": {
|
|
9404
|
+
"_primary": {
|
|
9405
|
+
"type": "boolean"
|
|
9406
|
+
},
|
|
9407
|
+
"postal_code": {
|
|
9408
|
+
"type": "string"
|
|
9409
|
+
},
|
|
9410
|
+
"city": {
|
|
9411
|
+
"type": "string"
|
|
9412
|
+
},
|
|
9413
|
+
"street": {
|
|
9414
|
+
"type": "string"
|
|
9415
|
+
},
|
|
9416
|
+
"street_number": {
|
|
9417
|
+
"type": "string"
|
|
9418
|
+
},
|
|
9419
|
+
"country": {
|
|
9420
|
+
"type": "string"
|
|
9421
|
+
}
|
|
9422
|
+
}
|
|
9423
|
+
}
|
|
9424
|
+
},
|
|
9425
|
+
"payment": {
|
|
9426
|
+
"type": "array",
|
|
9427
|
+
"description": "Payment methods",
|
|
9428
|
+
"items": {
|
|
9429
|
+
"type": "object",
|
|
9430
|
+
"properties": {
|
|
9431
|
+
"_primary": {
|
|
9432
|
+
"type": "boolean"
|
|
9433
|
+
}
|
|
9434
|
+
}
|
|
9435
|
+
}
|
|
9436
|
+
},
|
|
9437
|
+
"account": {
|
|
9438
|
+
"type": "array",
|
|
9439
|
+
"description": "Account relations",
|
|
9440
|
+
"items": {
|
|
9441
|
+
"type": "string"
|
|
9442
|
+
}
|
|
9443
|
+
},
|
|
9444
|
+
"marketing_permission": {
|
|
9445
|
+
"type": "boolean",
|
|
9446
|
+
"description": "Marketing Permission (deprecated)",
|
|
9447
|
+
"deprecated": true
|
|
9448
|
+
},
|
|
9449
|
+
"contact_owner": {
|
|
9450
|
+
"type": "string",
|
|
9451
|
+
"description": "Contact Owner user ID"
|
|
9452
|
+
},
|
|
9453
|
+
"consent_email_marketing": {
|
|
9454
|
+
"type": "object",
|
|
9455
|
+
"description": "Email Marketing consent"
|
|
9456
|
+
},
|
|
9457
|
+
"consent_sms_marketing": {
|
|
9458
|
+
"type": "object",
|
|
9459
|
+
"description": "SMS Marketing consent"
|
|
9460
|
+
},
|
|
9461
|
+
"consent_phone_call": {
|
|
9462
|
+
"type": "object",
|
|
9463
|
+
"description": "Direct Phone Marketing consent"
|
|
9464
|
+
},
|
|
9465
|
+
"consent_print_marketing": {
|
|
9466
|
+
"type": "object",
|
|
9467
|
+
"description": "Print Marketing consent"
|
|
9468
|
+
},
|
|
9469
|
+
"portal_users": {
|
|
9470
|
+
"type": "array",
|
|
9471
|
+
"description": "Portal Users relation",
|
|
9472
|
+
"items": {
|
|
9473
|
+
"type": "string"
|
|
9474
|
+
}
|
|
9475
|
+
},
|
|
9476
|
+
"opportunities": {
|
|
9477
|
+
"type": "array",
|
|
9478
|
+
"description": "Opportunities relation",
|
|
9479
|
+
"items": {
|
|
9480
|
+
"type": "string"
|
|
9481
|
+
}
|
|
9482
|
+
},
|
|
9483
|
+
"orders": {
|
|
9484
|
+
"type": "array",
|
|
9485
|
+
"description": "Orders relation",
|
|
9486
|
+
"items": {
|
|
9487
|
+
"type": "string"
|
|
9488
|
+
}
|
|
9489
|
+
},
|
|
9490
|
+
"contracts": {
|
|
9491
|
+
"type": "array",
|
|
9492
|
+
"description": "Contracts relation",
|
|
9493
|
+
"items": {
|
|
9494
|
+
"type": "string"
|
|
9495
|
+
}
|
|
9496
|
+
},
|
|
9497
|
+
"external_id": {
|
|
9498
|
+
"type": "string",
|
|
9499
|
+
"description": "External ID",
|
|
9500
|
+
"readOnly": true
|
|
9501
|
+
}
|
|
9502
|
+
}
|
|
9503
|
+
}
|
|
9504
|
+
},
|
|
9505
|
+
"required": [
|
|
9506
|
+
"contract",
|
|
9507
|
+
"contact"
|
|
9508
|
+
]
|
|
9509
|
+
},
|
|
9008
9510
|
"SearchExternalCatalogResult": {
|
|
9009
9511
|
"type": "object",
|
|
9010
9512
|
"properties": {
|
|
@@ -9086,6 +9588,9 @@
|
|
|
9086
9588
|
"contract_id": {
|
|
9087
9589
|
"type": "string",
|
|
9088
9590
|
"description": "The contract id to be used as source for the recommendation"
|
|
9591
|
+
},
|
|
9592
|
+
"filters": {
|
|
9593
|
+
"$ref": "#/components/schemas/AvailabilityFilters"
|
|
9089
9594
|
}
|
|
9090
9595
|
}
|
|
9091
9596
|
},
|
|
@@ -9112,14 +9617,26 @@
|
|
|
9112
9617
|
"Offer": {
|
|
9113
9618
|
"type": "object",
|
|
9114
9619
|
"properties": {
|
|
9115
|
-
"product_id": {
|
|
9116
|
-
"type": "string"
|
|
9117
|
-
},
|
|
9118
|
-
"price_id": {
|
|
9119
|
-
"type": "string"
|
|
9120
|
-
},
|
|
9121
9620
|
"target_id": {
|
|
9122
9621
|
"type": "string"
|
|
9622
|
+
},
|
|
9623
|
+
"items": {
|
|
9624
|
+
"type": "array",
|
|
9625
|
+
"items": {
|
|
9626
|
+
"type": "object",
|
|
9627
|
+
"properties": {
|
|
9628
|
+
"price_id": {
|
|
9629
|
+
"type": "string"
|
|
9630
|
+
},
|
|
9631
|
+
"product_id": {
|
|
9632
|
+
"type": "string"
|
|
9633
|
+
}
|
|
9634
|
+
},
|
|
9635
|
+
"required": [
|
|
9636
|
+
"price_id",
|
|
9637
|
+
"product_id"
|
|
9638
|
+
]
|
|
9639
|
+
}
|
|
9123
9640
|
}
|
|
9124
9641
|
}
|
|
9125
9642
|
},
|