@randock/nameshift-api-client 0.0.475 → 0.0.477
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/.openapi-generator/FILES +2 -0
- package/README.md +3 -3
- package/dist/apis/AdminApi.d.ts +15 -1
- package/dist/apis/AdminApi.js +58 -0
- package/dist/apis/BuyersApi.d.ts +15 -1
- package/dist/apis/BuyersApi.js +58 -0
- package/dist/models/AccountBankAccountSummaryDto.d.ts +59 -0
- package/dist/models/AccountBankAccountSummaryDto.js +72 -0
- package/dist/models/AdminListAccountDto.d.ts +7 -0
- package/dist/models/AdminListAccountDto.js +5 -0
- package/dist/models/BuyerSubscriptionListItemDto.d.ts +7 -0
- package/dist/models/BuyerSubscriptionListItemDto.js +5 -0
- package/dist/models/CompanyInformationDto.d.ts +2 -2
- package/dist/models/CustomerSuccessListAccountDto.d.ts +7 -0
- package/dist/models/CustomerSuccessListAccountDto.js +5 -0
- package/dist/models/SubscriptionDetailsDto.d.ts +7 -0
- package/dist/models/SubscriptionDetailsDto.js +5 -0
- package/dist/models/UpdateSubscriptionBuyerInformationInput.d.ts +33 -0
- package/dist/models/UpdateSubscriptionBuyerInformationInput.js +52 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/package.json +1 -1
- package/src/apis/AdminApi.ts +60 -0
- package/src/apis/BuyersApi.ts +60 -0
- package/src/models/AccountBankAccountSummaryDto.ts +105 -0
- package/src/models/AdminListAccountDto.ts +16 -0
- package/src/models/BuyerSubscriptionListItemDto.ts +16 -0
- package/src/models/CompanyInformationDto.ts +2 -2
- package/src/models/CustomerSuccessListAccountDto.ts +16 -0
- package/src/models/SubscriptionDetailsDto.ts +16 -0
- package/src/models/UpdateSubscriptionBuyerInformationInput.ts +74 -0
- package/src/models/index.ts +2 -0
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Nameshift
|
|
3
|
+
* Nameshift domain marketplace and management API. ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access. ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { BillingInformationDto } from './BillingInformationDto';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface UpdateSubscriptionBuyerInformationInput
|
|
17
|
+
*/
|
|
18
|
+
export interface UpdateSubscriptionBuyerInformationInput {
|
|
19
|
+
/**
|
|
20
|
+
* Billing information to store on the subscription. It is used to build the invoices of the upcoming renewals and does not modify the already issued ones.
|
|
21
|
+
* @type {BillingInformationDto}
|
|
22
|
+
* @memberof UpdateSubscriptionBuyerInformationInput
|
|
23
|
+
*/
|
|
24
|
+
billingInformation: BillingInformationDto;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Check if a given object implements the UpdateSubscriptionBuyerInformationInput interface.
|
|
28
|
+
*/
|
|
29
|
+
export declare function instanceOfUpdateSubscriptionBuyerInformationInput(value: object): value is UpdateSubscriptionBuyerInformationInput;
|
|
30
|
+
export declare function UpdateSubscriptionBuyerInformationInputFromJSON(json: any): UpdateSubscriptionBuyerInformationInput;
|
|
31
|
+
export declare function UpdateSubscriptionBuyerInformationInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSubscriptionBuyerInformationInput;
|
|
32
|
+
export declare function UpdateSubscriptionBuyerInformationInputToJSON(json: any): UpdateSubscriptionBuyerInformationInput;
|
|
33
|
+
export declare function UpdateSubscriptionBuyerInformationInputToJSONTyped(value?: UpdateSubscriptionBuyerInformationInput | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Nameshift
|
|
6
|
+
* Nameshift domain marketplace and management API. ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access. ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfUpdateSubscriptionBuyerInformationInput = instanceOfUpdateSubscriptionBuyerInformationInput;
|
|
17
|
+
exports.UpdateSubscriptionBuyerInformationInputFromJSON = UpdateSubscriptionBuyerInformationInputFromJSON;
|
|
18
|
+
exports.UpdateSubscriptionBuyerInformationInputFromJSONTyped = UpdateSubscriptionBuyerInformationInputFromJSONTyped;
|
|
19
|
+
exports.UpdateSubscriptionBuyerInformationInputToJSON = UpdateSubscriptionBuyerInformationInputToJSON;
|
|
20
|
+
exports.UpdateSubscriptionBuyerInformationInputToJSONTyped = UpdateSubscriptionBuyerInformationInputToJSONTyped;
|
|
21
|
+
var BillingInformationDto_1 = require("./BillingInformationDto");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the UpdateSubscriptionBuyerInformationInput interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfUpdateSubscriptionBuyerInformationInput(value) {
|
|
26
|
+
if (!('billingInformation' in value) || value['billingInformation'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
function UpdateSubscriptionBuyerInformationInputFromJSON(json) {
|
|
31
|
+
return UpdateSubscriptionBuyerInformationInputFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
function UpdateSubscriptionBuyerInformationInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'billingInformation': (0, BillingInformationDto_1.BillingInformationDtoFromJSON)(json['billingInformation']),
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
function UpdateSubscriptionBuyerInformationInputToJSON(json) {
|
|
42
|
+
return UpdateSubscriptionBuyerInformationInputToJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function UpdateSubscriptionBuyerInformationInputToJSONTyped(value, ignoreDiscriminator) {
|
|
45
|
+
if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
|
|
46
|
+
if (value == null) {
|
|
47
|
+
return value;
|
|
48
|
+
}
|
|
49
|
+
return {
|
|
50
|
+
'billingInformation': (0, BillingInformationDto_1.BillingInformationDtoToJSON)(value['billingInformation']),
|
|
51
|
+
};
|
|
52
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ export * from './AccountAliasDto';
|
|
|
2
2
|
export * from './AccountAliasInput';
|
|
3
3
|
export * from './AccountBankAccountDto';
|
|
4
4
|
export * from './AccountBankAccountDtoDetails';
|
|
5
|
+
export * from './AccountBankAccountSummaryDto';
|
|
5
6
|
export * from './AccountChallengeRewardUsageListItemDto';
|
|
6
7
|
export * from './AccountChallengeRewardUsageListItemDtoMetadata';
|
|
7
8
|
export * from './AccountCommissionByDateRangeDto';
|
|
@@ -540,6 +541,7 @@ export * from './UpdateMarketplaceInput';
|
|
|
540
541
|
export * from './UpdateOrderInput';
|
|
541
542
|
export * from './UpdateRentConfigurationDto';
|
|
542
543
|
export * from './UpdateSubscriptionBillingPeriodicityInput';
|
|
544
|
+
export * from './UpdateSubscriptionBuyerInformationInput';
|
|
543
545
|
export * from './UpdateSubscriptionDomainNameserversInput';
|
|
544
546
|
export * from './UpdateSubscriptionDomainRecordInput';
|
|
545
547
|
export * from './UpdateSubscriptionInput';
|
package/dist/models/index.js
CHANGED
|
@@ -20,6 +20,7 @@ __exportStar(require("./AccountAliasDto"), exports);
|
|
|
20
20
|
__exportStar(require("./AccountAliasInput"), exports);
|
|
21
21
|
__exportStar(require("./AccountBankAccountDto"), exports);
|
|
22
22
|
__exportStar(require("./AccountBankAccountDtoDetails"), exports);
|
|
23
|
+
__exportStar(require("./AccountBankAccountSummaryDto"), exports);
|
|
23
24
|
__exportStar(require("./AccountChallengeRewardUsageListItemDto"), exports);
|
|
24
25
|
__exportStar(require("./AccountChallengeRewardUsageListItemDtoMetadata"), exports);
|
|
25
26
|
__exportStar(require("./AccountCommissionByDateRangeDto"), exports);
|
|
@@ -558,6 +559,7 @@ __exportStar(require("./UpdateMarketplaceInput"), exports);
|
|
|
558
559
|
__exportStar(require("./UpdateOrderInput"), exports);
|
|
559
560
|
__exportStar(require("./UpdateRentConfigurationDto"), exports);
|
|
560
561
|
__exportStar(require("./UpdateSubscriptionBillingPeriodicityInput"), exports);
|
|
562
|
+
__exportStar(require("./UpdateSubscriptionBuyerInformationInput"), exports);
|
|
561
563
|
__exportStar(require("./UpdateSubscriptionDomainNameserversInput"), exports);
|
|
562
564
|
__exportStar(require("./UpdateSubscriptionDomainRecordInput"), exports);
|
|
563
565
|
__exportStar(require("./UpdateSubscriptionInput"), exports);
|
package/package.json
CHANGED
package/src/apis/AdminApi.ts
CHANGED
|
@@ -72,6 +72,7 @@ import type {
|
|
|
72
72
|
UpdateChallengeInput,
|
|
73
73
|
UpdateFeatureFlagInput,
|
|
74
74
|
UpdateMarketplaceInput,
|
|
75
|
+
UpdateSubscriptionBuyerInformationInput,
|
|
75
76
|
ValidationException,
|
|
76
77
|
} from '../models/index';
|
|
77
78
|
import {
|
|
@@ -189,6 +190,8 @@ import {
|
|
|
189
190
|
UpdateFeatureFlagInputToJSON,
|
|
190
191
|
UpdateMarketplaceInputFromJSON,
|
|
191
192
|
UpdateMarketplaceInputToJSON,
|
|
193
|
+
UpdateSubscriptionBuyerInformationInputFromJSON,
|
|
194
|
+
UpdateSubscriptionBuyerInformationInputToJSON,
|
|
192
195
|
ValidationExceptionFromJSON,
|
|
193
196
|
ValidationExceptionToJSON,
|
|
194
197
|
} from '../models/index';
|
|
@@ -542,6 +545,11 @@ export interface AdminApiUpdateMarketplaceRequest {
|
|
|
542
545
|
updateMarketplaceInput: UpdateMarketplaceInput;
|
|
543
546
|
}
|
|
544
547
|
|
|
548
|
+
export interface AdminApiUpdateSubscriptionBuyerInformationRequest {
|
|
549
|
+
subscriptionId: string;
|
|
550
|
+
updateSubscriptionBuyerInformationInput: UpdateSubscriptionBuyerInformationInput;
|
|
551
|
+
}
|
|
552
|
+
|
|
545
553
|
export interface AdminApiVerifyAccountAliasRequest {
|
|
546
554
|
accountId: string;
|
|
547
555
|
}
|
|
@@ -3872,6 +3880,58 @@ export class AdminApi extends runtime.BaseAPI {
|
|
|
3872
3880
|
await this.updateMarketplaceRaw(requestParameters, initOverrides);
|
|
3873
3881
|
}
|
|
3874
3882
|
|
|
3883
|
+
/**
|
|
3884
|
+
* Updates the buyer information stored on the subscription. The change is applied from the next renewal onwards: the already issued invoices, including the active one, are left untouched. Note that the emails related to the current invoice are still sent to the email of that invoice.
|
|
3885
|
+
* Update subscription buyer information
|
|
3886
|
+
*/
|
|
3887
|
+
async updateSubscriptionBuyerInformationRaw(requestParameters: AdminApiUpdateSubscriptionBuyerInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
3888
|
+
if (requestParameters['subscriptionId'] == null) {
|
|
3889
|
+
throw new runtime.RequiredError(
|
|
3890
|
+
'subscriptionId',
|
|
3891
|
+
'Required parameter "subscriptionId" was null or undefined when calling updateSubscriptionBuyerInformation().'
|
|
3892
|
+
);
|
|
3893
|
+
}
|
|
3894
|
+
|
|
3895
|
+
if (requestParameters['updateSubscriptionBuyerInformationInput'] == null) {
|
|
3896
|
+
throw new runtime.RequiredError(
|
|
3897
|
+
'updateSubscriptionBuyerInformationInput',
|
|
3898
|
+
'Required parameter "updateSubscriptionBuyerInformationInput" was null or undefined when calling updateSubscriptionBuyerInformation().'
|
|
3899
|
+
);
|
|
3900
|
+
}
|
|
3901
|
+
|
|
3902
|
+
const queryParameters: any = {};
|
|
3903
|
+
|
|
3904
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
3905
|
+
|
|
3906
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
3907
|
+
|
|
3908
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
3909
|
+
const token = this.configuration.accessToken;
|
|
3910
|
+
const tokenString = await token("bearer", []);
|
|
3911
|
+
|
|
3912
|
+
if (tokenString) {
|
|
3913
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
3914
|
+
}
|
|
3915
|
+
}
|
|
3916
|
+
const response = await this.request({
|
|
3917
|
+
path: `/admin/subscriptions/{subscriptionId}/buyer-information`.replace(`{${"subscriptionId"}}`, encodeURIComponent(String(requestParameters['subscriptionId']))),
|
|
3918
|
+
method: 'PATCH',
|
|
3919
|
+
headers: headerParameters,
|
|
3920
|
+
query: queryParameters,
|
|
3921
|
+
body: UpdateSubscriptionBuyerInformationInputToJSON(requestParameters['updateSubscriptionBuyerInformationInput']),
|
|
3922
|
+
}, initOverrides);
|
|
3923
|
+
|
|
3924
|
+
return new runtime.VoidApiResponse(response);
|
|
3925
|
+
}
|
|
3926
|
+
|
|
3927
|
+
/**
|
|
3928
|
+
* Updates the buyer information stored on the subscription. The change is applied from the next renewal onwards: the already issued invoices, including the active one, are left untouched. Note that the emails related to the current invoice are still sent to the email of that invoice.
|
|
3929
|
+
* Update subscription buyer information
|
|
3930
|
+
*/
|
|
3931
|
+
async updateSubscriptionBuyerInformation(requestParameters: AdminApiUpdateSubscriptionBuyerInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
3932
|
+
await this.updateSubscriptionBuyerInformationRaw(requestParameters, initOverrides);
|
|
3933
|
+
}
|
|
3934
|
+
|
|
3875
3935
|
/**
|
|
3876
3936
|
* Marks the account alias as verified.
|
|
3877
3937
|
* Verify account alias
|
package/src/apis/BuyersApi.ts
CHANGED
|
@@ -55,6 +55,7 @@ import type {
|
|
|
55
55
|
UpdateBuyerDomainTransferIpsTagInputDto,
|
|
56
56
|
UpdateBuyerNotificationSettingsInput,
|
|
57
57
|
UpdateLeadMuteStatusForBuyerInput,
|
|
58
|
+
UpdateSubscriptionBuyerInformationInput,
|
|
58
59
|
UpdateSubscriptionDomainNameserversInput,
|
|
59
60
|
UpdateSubscriptionDomainRecordInput,
|
|
60
61
|
UpdateTaskMuteStatusForBuyerInput,
|
|
@@ -142,6 +143,8 @@ import {
|
|
|
142
143
|
UpdateBuyerNotificationSettingsInputToJSON,
|
|
143
144
|
UpdateLeadMuteStatusForBuyerInputFromJSON,
|
|
144
145
|
UpdateLeadMuteStatusForBuyerInputToJSON,
|
|
146
|
+
UpdateSubscriptionBuyerInformationInputFromJSON,
|
|
147
|
+
UpdateSubscriptionBuyerInformationInputToJSON,
|
|
145
148
|
UpdateSubscriptionDomainNameserversInputFromJSON,
|
|
146
149
|
UpdateSubscriptionDomainNameserversInputToJSON,
|
|
147
150
|
UpdateSubscriptionDomainRecordInputFromJSON,
|
|
@@ -326,6 +329,11 @@ export interface BuyersApiUpdateBuyerNotificationSettingsRequest {
|
|
|
326
329
|
updateBuyerNotificationSettingsInput: UpdateBuyerNotificationSettingsInput;
|
|
327
330
|
}
|
|
328
331
|
|
|
332
|
+
export interface BuyersApiUpdateBuyerSubscriptionBuyerInformationRequest {
|
|
333
|
+
subscriptionId: string;
|
|
334
|
+
updateSubscriptionBuyerInformationInput: UpdateSubscriptionBuyerInformationInput;
|
|
335
|
+
}
|
|
336
|
+
|
|
329
337
|
export interface BuyersApiUpdateDomainTransferIpsTagRequest {
|
|
330
338
|
transferId: string;
|
|
331
339
|
updateBuyerDomainTransferIpsTagInputDto: UpdateBuyerDomainTransferIpsTagInputDto;
|
|
@@ -2191,6 +2199,58 @@ export class BuyersApi extends runtime.BaseAPI {
|
|
|
2191
2199
|
await this.updateBuyerNotificationSettingsRaw(requestParameters, initOverrides);
|
|
2192
2200
|
}
|
|
2193
2201
|
|
|
2202
|
+
/**
|
|
2203
|
+
* Updates the billing information stored on one of the subscriptions of the current buyer. The change is applied from the next renewal onwards: the already issued invoices, including the active one, are left untouched.
|
|
2204
|
+
* Update the billing information of a subscription
|
|
2205
|
+
*/
|
|
2206
|
+
async updateBuyerSubscriptionBuyerInformationRaw(requestParameters: BuyersApiUpdateBuyerSubscriptionBuyerInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
2207
|
+
if (requestParameters['subscriptionId'] == null) {
|
|
2208
|
+
throw new runtime.RequiredError(
|
|
2209
|
+
'subscriptionId',
|
|
2210
|
+
'Required parameter "subscriptionId" was null or undefined when calling updateBuyerSubscriptionBuyerInformation().'
|
|
2211
|
+
);
|
|
2212
|
+
}
|
|
2213
|
+
|
|
2214
|
+
if (requestParameters['updateSubscriptionBuyerInformationInput'] == null) {
|
|
2215
|
+
throw new runtime.RequiredError(
|
|
2216
|
+
'updateSubscriptionBuyerInformationInput',
|
|
2217
|
+
'Required parameter "updateSubscriptionBuyerInformationInput" was null or undefined when calling updateBuyerSubscriptionBuyerInformation().'
|
|
2218
|
+
);
|
|
2219
|
+
}
|
|
2220
|
+
|
|
2221
|
+
const queryParameters: any = {};
|
|
2222
|
+
|
|
2223
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
2224
|
+
|
|
2225
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
2226
|
+
|
|
2227
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
2228
|
+
const token = this.configuration.accessToken;
|
|
2229
|
+
const tokenString = await token("bearer", []);
|
|
2230
|
+
|
|
2231
|
+
if (tokenString) {
|
|
2232
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
2233
|
+
}
|
|
2234
|
+
}
|
|
2235
|
+
const response = await this.request({
|
|
2236
|
+
path: `/buyers/private/subscriptions/{subscriptionId}/buyer-information`.replace(`{${"subscriptionId"}}`, encodeURIComponent(String(requestParameters['subscriptionId']))),
|
|
2237
|
+
method: 'PATCH',
|
|
2238
|
+
headers: headerParameters,
|
|
2239
|
+
query: queryParameters,
|
|
2240
|
+
body: UpdateSubscriptionBuyerInformationInputToJSON(requestParameters['updateSubscriptionBuyerInformationInput']),
|
|
2241
|
+
}, initOverrides);
|
|
2242
|
+
|
|
2243
|
+
return new runtime.VoidApiResponse(response);
|
|
2244
|
+
}
|
|
2245
|
+
|
|
2246
|
+
/**
|
|
2247
|
+
* Updates the billing information stored on one of the subscriptions of the current buyer. The change is applied from the next renewal onwards: the already issued invoices, including the active one, are left untouched.
|
|
2248
|
+
* Update the billing information of a subscription
|
|
2249
|
+
*/
|
|
2250
|
+
async updateBuyerSubscriptionBuyerInformation(requestParameters: BuyersApiUpdateBuyerSubscriptionBuyerInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
2251
|
+
await this.updateBuyerSubscriptionBuyerInformationRaw(requestParameters, initOverrides);
|
|
2252
|
+
}
|
|
2253
|
+
|
|
2194
2254
|
/**
|
|
2195
2255
|
* Updates the IPS tag for a .uk domain transfer during the buyer workflow step.
|
|
2196
2256
|
* Update IPS tag
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Nameshift
|
|
5
|
+
* Nameshift domain marketplace and management API. ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access. ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AccountBankAccountSummaryDto
|
|
20
|
+
*/
|
|
21
|
+
export interface AccountBankAccountSummaryDto {
|
|
22
|
+
/**
|
|
23
|
+
* ISO 4217 currency code for the account.
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof AccountBankAccountSummaryDto
|
|
26
|
+
*/
|
|
27
|
+
currencyCode: string;
|
|
28
|
+
/**
|
|
29
|
+
* ISO country code of the bank.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AccountBankAccountSummaryDto
|
|
32
|
+
*/
|
|
33
|
+
countryCode: string;
|
|
34
|
+
/**
|
|
35
|
+
* Last digits of the account number or IBAN.
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof AccountBankAccountSummaryDto
|
|
38
|
+
*/
|
|
39
|
+
reference: string;
|
|
40
|
+
/**
|
|
41
|
+
* Verification status with the payment provider.
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof AccountBankAccountSummaryDto
|
|
44
|
+
*/
|
|
45
|
+
verificationStatus: AccountBankAccountSummaryDtoVerificationStatusEnum;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* @export
|
|
51
|
+
*/
|
|
52
|
+
export const AccountBankAccountSummaryDtoVerificationStatusEnum = {
|
|
53
|
+
PENDING: 'pending',
|
|
54
|
+
VERIFIED: 'verified',
|
|
55
|
+
REJECTED: 'rejected'
|
|
56
|
+
} as const;
|
|
57
|
+
export type AccountBankAccountSummaryDtoVerificationStatusEnum = typeof AccountBankAccountSummaryDtoVerificationStatusEnum[keyof typeof AccountBankAccountSummaryDtoVerificationStatusEnum];
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Check if a given object implements the AccountBankAccountSummaryDto interface.
|
|
62
|
+
*/
|
|
63
|
+
export function instanceOfAccountBankAccountSummaryDto(value: object): value is AccountBankAccountSummaryDto {
|
|
64
|
+
if (!('currencyCode' in value) || value['currencyCode'] === undefined) return false;
|
|
65
|
+
if (!('countryCode' in value) || value['countryCode'] === undefined) return false;
|
|
66
|
+
if (!('reference' in value) || value['reference'] === undefined) return false;
|
|
67
|
+
if (!('verificationStatus' in value) || value['verificationStatus'] === undefined) return false;
|
|
68
|
+
return true;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export function AccountBankAccountSummaryDtoFromJSON(json: any): AccountBankAccountSummaryDto {
|
|
72
|
+
return AccountBankAccountSummaryDtoFromJSONTyped(json, false);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export function AccountBankAccountSummaryDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountBankAccountSummaryDto {
|
|
76
|
+
if (json == null) {
|
|
77
|
+
return json;
|
|
78
|
+
}
|
|
79
|
+
return {
|
|
80
|
+
|
|
81
|
+
'currencyCode': json['currencyCode'],
|
|
82
|
+
'countryCode': json['countryCode'],
|
|
83
|
+
'reference': json['reference'],
|
|
84
|
+
'verificationStatus': json['verificationStatus'],
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export function AccountBankAccountSummaryDtoToJSON(json: any): AccountBankAccountSummaryDto {
|
|
89
|
+
return AccountBankAccountSummaryDtoToJSONTyped(json, false);
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export function AccountBankAccountSummaryDtoToJSONTyped(value?: AccountBankAccountSummaryDto | null, ignoreDiscriminator: boolean = false): any {
|
|
93
|
+
if (value == null) {
|
|
94
|
+
return value;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
return {
|
|
98
|
+
|
|
99
|
+
'currencyCode': value['currencyCode'],
|
|
100
|
+
'countryCode': value['countryCode'],
|
|
101
|
+
'reference': value['reference'],
|
|
102
|
+
'verificationStatus': value['verificationStatus'],
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
|
|
@@ -27,6 +27,13 @@ import {
|
|
|
27
27
|
ChallengeRewardBalanceDtoToJSON,
|
|
28
28
|
ChallengeRewardBalanceDtoToJSONTyped,
|
|
29
29
|
} from './ChallengeRewardBalanceDto';
|
|
30
|
+
import type { AccountBankAccountSummaryDto } from './AccountBankAccountSummaryDto';
|
|
31
|
+
import {
|
|
32
|
+
AccountBankAccountSummaryDtoFromJSON,
|
|
33
|
+
AccountBankAccountSummaryDtoFromJSONTyped,
|
|
34
|
+
AccountBankAccountSummaryDtoToJSON,
|
|
35
|
+
AccountBankAccountSummaryDtoToJSONTyped,
|
|
36
|
+
} from './AccountBankAccountSummaryDto';
|
|
30
37
|
import type { ListAccountPortfolioSizeDto } from './ListAccountPortfolioSizeDto';
|
|
31
38
|
import {
|
|
32
39
|
ListAccountPortfolioSizeDtoFromJSON,
|
|
@@ -72,6 +79,12 @@ export interface AdminListAccountDto {
|
|
|
72
79
|
* @memberof AdminListAccountDto
|
|
73
80
|
*/
|
|
74
81
|
notesLastUpdatedAt: Date | null;
|
|
82
|
+
/**
|
|
83
|
+
* The bank accounts of the account, and their verification.
|
|
84
|
+
* @type {Array<AccountBankAccountSummaryDto>}
|
|
85
|
+
* @memberof AdminListAccountDto
|
|
86
|
+
*/
|
|
87
|
+
bankAccounts: Array<AccountBankAccountSummaryDto>;
|
|
75
88
|
/**
|
|
76
89
|
* Account creation date.
|
|
77
90
|
* @type {Date}
|
|
@@ -208,6 +221,7 @@ export function instanceOfAdminListAccountDto(value: object): value is AdminList
|
|
|
208
221
|
if (!('identifier' in value) || value['identifier'] === undefined) return false;
|
|
209
222
|
if (!('notesNumber' in value) || value['notesNumber'] === undefined) return false;
|
|
210
223
|
if (!('notesLastUpdatedAt' in value) || value['notesLastUpdatedAt'] === undefined) return false;
|
|
224
|
+
if (!('bankAccounts' in value) || value['bankAccounts'] === undefined) return false;
|
|
211
225
|
if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
|
|
212
226
|
if (!('name' in value) || value['name'] === undefined) return false;
|
|
213
227
|
if (!('type' in value) || value['type'] === undefined) return false;
|
|
@@ -241,6 +255,7 @@ export function AdminListAccountDtoFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
241
255
|
'identifier': json['identifier'],
|
|
242
256
|
'notesNumber': json['notesNumber'],
|
|
243
257
|
'notesLastUpdatedAt': (json['notesLastUpdatedAt'] == null ? null : new Date(json['notesLastUpdatedAt'])),
|
|
258
|
+
'bankAccounts': ((json['bankAccounts'] as Array<any>).map(AccountBankAccountSummaryDtoFromJSON)),
|
|
244
259
|
'createdAt': (new Date(json['createdAt'])),
|
|
245
260
|
'name': json['name'],
|
|
246
261
|
'type': json['type'],
|
|
@@ -275,6 +290,7 @@ export function AdminListAccountDtoToJSONTyped(value?: AdminListAccountDto | nul
|
|
|
275
290
|
'identifier': value['identifier'],
|
|
276
291
|
'notesNumber': value['notesNumber'],
|
|
277
292
|
'notesLastUpdatedAt': (value['notesLastUpdatedAt'] == null ? null : (value['notesLastUpdatedAt'] as any).toISOString()),
|
|
293
|
+
'bankAccounts': ((value['bankAccounts'] as Array<any>).map(AccountBankAccountSummaryDtoToJSON)),
|
|
278
294
|
'createdAt': ((value['createdAt']).toISOString()),
|
|
279
295
|
'name': value['name'],
|
|
280
296
|
'type': value['type'],
|
|
@@ -27,6 +27,13 @@ import {
|
|
|
27
27
|
MoneyDtoToJSON,
|
|
28
28
|
MoneyDtoToJSONTyped,
|
|
29
29
|
} from './MoneyDto';
|
|
30
|
+
import type { BillingInformationDto } from './BillingInformationDto';
|
|
31
|
+
import {
|
|
32
|
+
BillingInformationDtoFromJSON,
|
|
33
|
+
BillingInformationDtoFromJSONTyped,
|
|
34
|
+
BillingInformationDtoToJSON,
|
|
35
|
+
BillingInformationDtoToJSONTyped,
|
|
36
|
+
} from './BillingInformationDto';
|
|
30
37
|
|
|
31
38
|
/**
|
|
32
39
|
*
|
|
@@ -124,6 +131,12 @@ export interface BuyerSubscriptionListItemDto {
|
|
|
124
131
|
* @memberof BuyerSubscriptionListItemDto
|
|
125
132
|
*/
|
|
126
133
|
canManageDomainDns: boolean;
|
|
134
|
+
/**
|
|
135
|
+
* Billing information of the subscription. It is the one used to build the invoices of the upcoming renewals.
|
|
136
|
+
* @type {BillingInformationDto}
|
|
137
|
+
* @memberof BuyerSubscriptionListItemDto
|
|
138
|
+
*/
|
|
139
|
+
buyerInformation: BillingInformationDto;
|
|
127
140
|
}
|
|
128
141
|
|
|
129
142
|
|
|
@@ -177,6 +190,7 @@ export function instanceOfBuyerSubscriptionListItemDto(value: object): value is
|
|
|
177
190
|
if (!('renewAt' in value) || value['renewAt'] === undefined) return false;
|
|
178
191
|
if (!('paymentUrl' in value) || value['paymentUrl'] === undefined) return false;
|
|
179
192
|
if (!('canManageDomainDns' in value) || value['canManageDomainDns'] === undefined) return false;
|
|
193
|
+
if (!('buyerInformation' in value) || value['buyerInformation'] === undefined) return false;
|
|
180
194
|
return true;
|
|
181
195
|
}
|
|
182
196
|
|
|
@@ -205,6 +219,7 @@ export function BuyerSubscriptionListItemDtoFromJSONTyped(json: any, ignoreDiscr
|
|
|
205
219
|
'renewAt': (new Date(json['renewAt'])),
|
|
206
220
|
'paymentUrl': json['paymentUrl'],
|
|
207
221
|
'canManageDomainDns': json['canManageDomainDns'],
|
|
222
|
+
'buyerInformation': BillingInformationDtoFromJSON(json['buyerInformation']),
|
|
208
223
|
};
|
|
209
224
|
}
|
|
210
225
|
|
|
@@ -234,6 +249,7 @@ export function BuyerSubscriptionListItemDtoToJSONTyped(value?: BuyerSubscriptio
|
|
|
234
249
|
'renewAt': ((value['renewAt']).toISOString()),
|
|
235
250
|
'paymentUrl': value['paymentUrl'],
|
|
236
251
|
'canManageDomainDns': value['canManageDomainDns'],
|
|
252
|
+
'buyerInformation': BillingInformationDtoToJSON(value['buyerInformation']),
|
|
237
253
|
};
|
|
238
254
|
}
|
|
239
255
|
|
|
@@ -34,11 +34,11 @@ export interface CompanyInformationDto {
|
|
|
34
34
|
*/
|
|
35
35
|
name: string;
|
|
36
36
|
/**
|
|
37
|
-
* Company tax identification details.
|
|
37
|
+
* Company tax identification details. A company is not required to have one.
|
|
38
38
|
* @type {CompanyTaxIdDto}
|
|
39
39
|
* @memberof CompanyInformationDto
|
|
40
40
|
*/
|
|
41
|
-
taxId: CompanyTaxIdDto;
|
|
41
|
+
taxId: CompanyTaxIdDto | null;
|
|
42
42
|
/**
|
|
43
43
|
* Optional company registration or chamber of commerce ID.
|
|
44
44
|
* @type {string}
|
|
@@ -41,6 +41,13 @@ import {
|
|
|
41
41
|
CustomerSuccessListAccountPortfolioSizeDtoToJSON,
|
|
42
42
|
CustomerSuccessListAccountPortfolioSizeDtoToJSONTyped,
|
|
43
43
|
} from './CustomerSuccessListAccountPortfolioSizeDto';
|
|
44
|
+
import type { AccountBankAccountSummaryDto } from './AccountBankAccountSummaryDto';
|
|
45
|
+
import {
|
|
46
|
+
AccountBankAccountSummaryDtoFromJSON,
|
|
47
|
+
AccountBankAccountSummaryDtoFromJSONTyped,
|
|
48
|
+
AccountBankAccountSummaryDtoToJSON,
|
|
49
|
+
AccountBankAccountSummaryDtoToJSONTyped,
|
|
50
|
+
} from './AccountBankAccountSummaryDto';
|
|
44
51
|
|
|
45
52
|
/**
|
|
46
53
|
*
|
|
@@ -72,6 +79,12 @@ export interface CustomerSuccessListAccountDto {
|
|
|
72
79
|
* @memberof CustomerSuccessListAccountDto
|
|
73
80
|
*/
|
|
74
81
|
notesLastUpdatedAt: Date | null;
|
|
82
|
+
/**
|
|
83
|
+
* The bank accounts of the account, and their verification.
|
|
84
|
+
* @type {Array<AccountBankAccountSummaryDto>}
|
|
85
|
+
* @memberof CustomerSuccessListAccountDto
|
|
86
|
+
*/
|
|
87
|
+
bankAccounts: Array<AccountBankAccountSummaryDto>;
|
|
75
88
|
/**
|
|
76
89
|
* Account creation date.
|
|
77
90
|
* @type {Date}
|
|
@@ -208,6 +221,7 @@ export function instanceOfCustomerSuccessListAccountDto(value: object): value is
|
|
|
208
221
|
if (!('identifier' in value) || value['identifier'] === undefined) return false;
|
|
209
222
|
if (!('notesNumber' in value) || value['notesNumber'] === undefined) return false;
|
|
210
223
|
if (!('notesLastUpdatedAt' in value) || value['notesLastUpdatedAt'] === undefined) return false;
|
|
224
|
+
if (!('bankAccounts' in value) || value['bankAccounts'] === undefined) return false;
|
|
211
225
|
if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
|
|
212
226
|
if (!('name' in value) || value['name'] === undefined) return false;
|
|
213
227
|
if (!('type' in value) || value['type'] === undefined) return false;
|
|
@@ -241,6 +255,7 @@ export function CustomerSuccessListAccountDtoFromJSONTyped(json: any, ignoreDisc
|
|
|
241
255
|
'identifier': json['identifier'],
|
|
242
256
|
'notesNumber': json['notesNumber'],
|
|
243
257
|
'notesLastUpdatedAt': (json['notesLastUpdatedAt'] == null ? null : new Date(json['notesLastUpdatedAt'])),
|
|
258
|
+
'bankAccounts': ((json['bankAccounts'] as Array<any>).map(AccountBankAccountSummaryDtoFromJSON)),
|
|
244
259
|
'createdAt': (new Date(json['createdAt'])),
|
|
245
260
|
'name': json['name'],
|
|
246
261
|
'type': json['type'],
|
|
@@ -275,6 +290,7 @@ export function CustomerSuccessListAccountDtoToJSONTyped(value?: CustomerSuccess
|
|
|
275
290
|
'identifier': value['identifier'],
|
|
276
291
|
'notesNumber': value['notesNumber'],
|
|
277
292
|
'notesLastUpdatedAt': (value['notesLastUpdatedAt'] == null ? null : (value['notesLastUpdatedAt'] as any).toISOString()),
|
|
293
|
+
'bankAccounts': ((value['bankAccounts'] as Array<any>).map(AccountBankAccountSummaryDtoToJSON)),
|
|
278
294
|
'createdAt': ((value['createdAt']).toISOString()),
|
|
279
295
|
'name': value['name'],
|
|
280
296
|
'type': value['type'],
|
|
@@ -76,6 +76,13 @@ import {
|
|
|
76
76
|
SubscriptionDetailsDomainSellerDtoToJSON,
|
|
77
77
|
SubscriptionDetailsDomainSellerDtoToJSONTyped,
|
|
78
78
|
} from './SubscriptionDetailsDomainSellerDto';
|
|
79
|
+
import type { BillingInformationDto } from './BillingInformationDto';
|
|
80
|
+
import {
|
|
81
|
+
BillingInformationDtoFromJSON,
|
|
82
|
+
BillingInformationDtoFromJSONTyped,
|
|
83
|
+
BillingInformationDtoToJSON,
|
|
84
|
+
BillingInformationDtoToJSONTyped,
|
|
85
|
+
} from './BillingInformationDto';
|
|
79
86
|
|
|
80
87
|
/**
|
|
81
88
|
*
|
|
@@ -173,6 +180,12 @@ export interface SubscriptionDetailsDto {
|
|
|
173
180
|
* @memberof SubscriptionDetailsDto
|
|
174
181
|
*/
|
|
175
182
|
companyInfo: SubscriptionCompanyInfoDto | null;
|
|
183
|
+
/**
|
|
184
|
+
* Buyer billing information as stored on the subscription. It is the editable one, used to build the invoices of the upcoming renewals.
|
|
185
|
+
* @type {BillingInformationDto}
|
|
186
|
+
* @memberof SubscriptionDetailsDto
|
|
187
|
+
*/
|
|
188
|
+
buyerInformation: BillingInformationDto;
|
|
176
189
|
/**
|
|
177
190
|
* Subscribed domain.
|
|
178
191
|
* @type {SubscriptionDetailsDomainDto}
|
|
@@ -406,6 +419,7 @@ export function instanceOfSubscriptionDetailsDto(value: object): value is Subscr
|
|
|
406
419
|
if (!('address' in value) || value['address'] === undefined) return false;
|
|
407
420
|
if (!('locale' in value) || value['locale'] === undefined) return false;
|
|
408
421
|
if (!('companyInfo' in value) || value['companyInfo'] === undefined) return false;
|
|
422
|
+
if (!('buyerInformation' in value) || value['buyerInformation'] === undefined) return false;
|
|
409
423
|
if (!('domain' in value) || value['domain'] === undefined) return false;
|
|
410
424
|
if (!('type' in value) || value['type'] === undefined) return false;
|
|
411
425
|
if (!('installments' in value) || value['installments'] === undefined) return false;
|
|
@@ -457,6 +471,7 @@ export function SubscriptionDetailsDtoFromJSONTyped(json: any, ignoreDiscriminat
|
|
|
457
471
|
'address': AddressDtoFromJSON(json['address']),
|
|
458
472
|
'locale': json['locale'],
|
|
459
473
|
'companyInfo': SubscriptionCompanyInfoDtoFromJSON(json['companyInfo']),
|
|
474
|
+
'buyerInformation': BillingInformationDtoFromJSON(json['buyerInformation']),
|
|
460
475
|
'domain': SubscriptionDetailsDomainDtoFromJSON(json['domain']),
|
|
461
476
|
'type': json['type'],
|
|
462
477
|
'installments': json['installments'],
|
|
@@ -509,6 +524,7 @@ export function SubscriptionDetailsDtoToJSONTyped(value?: SubscriptionDetailsDto
|
|
|
509
524
|
'address': AddressDtoToJSON(value['address']),
|
|
510
525
|
'locale': value['locale'],
|
|
511
526
|
'companyInfo': SubscriptionCompanyInfoDtoToJSON(value['companyInfo']),
|
|
527
|
+
'buyerInformation': BillingInformationDtoToJSON(value['buyerInformation']),
|
|
512
528
|
'domain': SubscriptionDetailsDomainDtoToJSON(value['domain']),
|
|
513
529
|
'type': value['type'],
|
|
514
530
|
'installments': value['installments'],
|