@randock/nameshift-api-client 0.0.498 → 0.0.499

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.
Files changed (54) hide show
  1. package/.openapi-generator/FILES +7 -0
  2. package/README.md +3 -3
  3. package/dist/apis/AccountsApi.d.ts +15 -1
  4. package/dist/apis/AccountsApi.js +66 -0
  5. package/dist/apis/AdminApi.d.ts +27 -15
  6. package/dist/apis/AdminApi.js +78 -22
  7. package/dist/models/AccountBankAccountDto.d.ts +21 -0
  8. package/dist/models/AccountBankAccountDto.js +17 -1
  9. package/dist/models/AccountPayoutDto.d.ts +13 -0
  10. package/dist/models/AccountPayoutDto.js +9 -0
  11. package/dist/models/BankAccountFormatCountryDto.d.ts +7 -1
  12. package/dist/models/BankAccountFormatCountryDto.js +4 -0
  13. package/dist/models/BankAccountFormatDto.d.ts +14 -0
  14. package/dist/models/BankAccountFormatDto.js +10 -0
  15. package/dist/models/BankAccountTransferMethod.d.ts +25 -0
  16. package/dist/models/BankAccountTransferMethod.js +51 -0
  17. package/dist/models/InvoiceDto.d.ts +13 -0
  18. package/dist/models/InvoiceDto.js +9 -0
  19. package/dist/models/InvoicePayoutDto.d.ts +71 -0
  20. package/dist/models/InvoicePayoutDto.js +78 -0
  21. package/dist/models/InvoiceSellerAccountDto.d.ts +13 -0
  22. package/dist/models/InvoiceSellerAccountDto.js +9 -0
  23. package/dist/models/PaySellerInvoicesInput.d.ts +32 -0
  24. package/dist/models/PaySellerInvoicesInput.js +51 -0
  25. package/dist/models/PayoutFrequency.d.ts +28 -0
  26. package/dist/models/PayoutFrequency.js +54 -0
  27. package/dist/models/SellerInvoiceDto.d.ts +13 -0
  28. package/dist/models/SellerInvoiceDto.js +9 -0
  29. package/dist/models/SellerPayoutPreviewDto.d.ts +60 -0
  30. package/dist/models/SellerPayoutPreviewDto.js +73 -0
  31. package/dist/models/SellerPayoutStatus.d.ts +26 -0
  32. package/dist/models/SellerPayoutStatus.js +52 -0
  33. package/dist/models/SetPayoutFrequencyInput.d.ts +39 -0
  34. package/dist/models/SetPayoutFrequencyInput.js +54 -0
  35. package/dist/models/index.d.ts +7 -0
  36. package/dist/models/index.js +7 -0
  37. package/package.json +1 -1
  38. package/src/apis/AccountsApi.ts +64 -0
  39. package/src/apis/AdminApi.ts +82 -31
  40. package/src/models/AccountBankAccountDto.ts +34 -0
  41. package/src/models/AccountPayoutDto.ts +26 -0
  42. package/src/models/BankAccountFormatCountryDto.ts +10 -1
  43. package/src/models/BankAccountFormatDto.ts +34 -0
  44. package/src/models/BankAccountTransferMethod.ts +53 -0
  45. package/src/models/InvoiceDto.ts +25 -0
  46. package/src/models/InvoicePayoutDto.ts +144 -0
  47. package/src/models/InvoiceSellerAccountDto.ts +26 -0
  48. package/src/models/PaySellerInvoicesInput.ts +66 -0
  49. package/src/models/PayoutFrequency.ts +56 -0
  50. package/src/models/SellerInvoiceDto.ts +25 -0
  51. package/src/models/SellerPayoutPreviewDto.ts +119 -0
  52. package/src/models/SellerPayoutStatus.ts +54 -0
  53. package/src/models/SetPayoutFrequencyInput.ts +84 -0
  54. package/src/models/index.ts +7 -0
@@ -10,6 +10,8 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { BankAccountFormatFieldDto } from './BankAccountFormatFieldDto';
13
+ import type { MoneyDto } from './MoneyDto';
14
+ import type { BankAccountTransferMethod } from './BankAccountTransferMethod';
13
15
  /**
14
16
  *
15
17
  * @export
@@ -28,6 +30,18 @@ export interface BankAccountFormatDto {
28
30
  * @memberof BankAccountFormatDto
29
31
  */
30
32
  currencyCode: string;
33
+ /**
34
+ * How we pay out to such an account: LOCAL over the country's own clearing system, which costs the seller nothing, or SWIFT, an international transfer whose fee is taken out of each payout.
35
+ * @type {BankAccountTransferMethod}
36
+ * @memberof BankAccountFormatDto
37
+ */
38
+ transferMethod: BankAccountTransferMethod;
39
+ /**
40
+ * What a payout to such an account costs the seller, as an indication: the fee of a SWIFT transfer in the account currency at the rate of the day. Null for a local payout, and when the fee is not known.
41
+ * @type {MoneyDto}
42
+ * @memberof BankAccountFormatDto
43
+ */
44
+ payoutFee: MoneyDto | null;
31
45
  /**
32
46
  * The fields to fill in, in display order.
33
47
  * @type {Array<BankAccountFormatFieldDto>}
@@ -19,6 +19,8 @@ exports.BankAccountFormatDtoFromJSONTyped = BankAccountFormatDtoFromJSONTyped;
19
19
  exports.BankAccountFormatDtoToJSON = BankAccountFormatDtoToJSON;
20
20
  exports.BankAccountFormatDtoToJSONTyped = BankAccountFormatDtoToJSONTyped;
21
21
  var BankAccountFormatFieldDto_1 = require("./BankAccountFormatFieldDto");
22
+ var MoneyDto_1 = require("./MoneyDto");
23
+ var BankAccountTransferMethod_1 = require("./BankAccountTransferMethod");
22
24
  /**
23
25
  * Check if a given object implements the BankAccountFormatDto interface.
24
26
  */
@@ -27,6 +29,10 @@ function instanceOfBankAccountFormatDto(value) {
27
29
  return false;
28
30
  if (!('currencyCode' in value) || value['currencyCode'] === undefined)
29
31
  return false;
32
+ if (!('transferMethod' in value) || value['transferMethod'] === undefined)
33
+ return false;
34
+ if (!('payoutFee' in value) || value['payoutFee'] === undefined)
35
+ return false;
30
36
  if (!('fields' in value) || value['fields'] === undefined)
31
37
  return false;
32
38
  return true;
@@ -41,6 +47,8 @@ function BankAccountFormatDtoFromJSONTyped(json, ignoreDiscriminator) {
41
47
  return {
42
48
  'countryCode': json['countryCode'],
43
49
  'currencyCode': json['currencyCode'],
50
+ 'transferMethod': (0, BankAccountTransferMethod_1.BankAccountTransferMethodFromJSON)(json['transferMethod']),
51
+ 'payoutFee': (0, MoneyDto_1.MoneyDtoFromJSON)(json['payoutFee']),
44
52
  'fields': (json['fields'].map(BankAccountFormatFieldDto_1.BankAccountFormatFieldDtoFromJSON)),
45
53
  };
46
54
  }
@@ -55,6 +63,8 @@ function BankAccountFormatDtoToJSONTyped(value, ignoreDiscriminator) {
55
63
  return {
56
64
  'countryCode': value['countryCode'],
57
65
  'currencyCode': value['currencyCode'],
66
+ 'transferMethod': (0, BankAccountTransferMethod_1.BankAccountTransferMethodToJSON)(value['transferMethod']),
67
+ 'payoutFee': (0, MoneyDto_1.MoneyDtoToJSON)(value['payoutFee']),
58
68
  'fields': (value['fields'].map(BankAccountFormatFieldDto_1.BankAccountFormatFieldDtoToJSON)),
59
69
  };
60
70
  }
@@ -0,0 +1,25 @@
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
+ /**
13
+ * How the payout reaches the bank account: LOCAL over the country's own clearing system, or SWIFT, an international transfer with a fee.
14
+ * @export
15
+ */
16
+ export declare const BankAccountTransferMethod: {
17
+ readonly LOCAL: "LOCAL";
18
+ readonly SWIFT: "SWIFT";
19
+ };
20
+ export type BankAccountTransferMethod = typeof BankAccountTransferMethod[keyof typeof BankAccountTransferMethod];
21
+ export declare function instanceOfBankAccountTransferMethod(value: any): boolean;
22
+ export declare function BankAccountTransferMethodFromJSON(json: any): BankAccountTransferMethod;
23
+ export declare function BankAccountTransferMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): BankAccountTransferMethod;
24
+ export declare function BankAccountTransferMethodToJSON(value?: BankAccountTransferMethod | null): any;
25
+ export declare function BankAccountTransferMethodToJSONTyped(value: any, ignoreDiscriminator: boolean): BankAccountTransferMethod;
@@ -0,0 +1,51 @@
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.BankAccountTransferMethod = void 0;
17
+ exports.instanceOfBankAccountTransferMethod = instanceOfBankAccountTransferMethod;
18
+ exports.BankAccountTransferMethodFromJSON = BankAccountTransferMethodFromJSON;
19
+ exports.BankAccountTransferMethodFromJSONTyped = BankAccountTransferMethodFromJSONTyped;
20
+ exports.BankAccountTransferMethodToJSON = BankAccountTransferMethodToJSON;
21
+ exports.BankAccountTransferMethodToJSONTyped = BankAccountTransferMethodToJSONTyped;
22
+ /**
23
+ * How the payout reaches the bank account: LOCAL over the country's own clearing system, or SWIFT, an international transfer with a fee.
24
+ * @export
25
+ */
26
+ exports.BankAccountTransferMethod = {
27
+ LOCAL: 'LOCAL',
28
+ SWIFT: 'SWIFT'
29
+ };
30
+ function instanceOfBankAccountTransferMethod(value) {
31
+ for (var key in exports.BankAccountTransferMethod) {
32
+ if (Object.prototype.hasOwnProperty.call(exports.BankAccountTransferMethod, key)) {
33
+ if (exports.BankAccountTransferMethod[key] === value) {
34
+ return true;
35
+ }
36
+ }
37
+ }
38
+ return false;
39
+ }
40
+ function BankAccountTransferMethodFromJSON(json) {
41
+ return BankAccountTransferMethodFromJSONTyped(json, false);
42
+ }
43
+ function BankAccountTransferMethodFromJSONTyped(json, ignoreDiscriminator) {
44
+ return json;
45
+ }
46
+ function BankAccountTransferMethodToJSON(value) {
47
+ return value;
48
+ }
49
+ function BankAccountTransferMethodToJSONTyped(value, ignoreDiscriminator) {
50
+ return value;
51
+ }
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import type { InvoiceDomainDto } from './InvoiceDomainDto';
13
13
  import type { InvoiceSellerAccountDto } from './InvoiceSellerAccountDto';
14
+ import type { InvoicePayoutDto } from './InvoicePayoutDto';
14
15
  import type { MoneyDto } from './MoneyDto';
15
16
  import type { InvoiceDtoTransaction } from './InvoiceDtoTransaction';
16
17
  /**
@@ -97,6 +98,18 @@ export interface InvoiceDto {
97
98
  * @memberof InvoiceDto
98
99
  */
99
100
  transaction: InvoiceDtoTransaction | null;
101
+ /**
102
+ * For a seller invoice awaiting its payout: when it is due, by how often the seller wants to be paid out. A payout that costs the seller nothing is due right away, unless they want those to wait too, and so is every invoice of a seller who is not paid out automatically. Null when it awaits no payout.
103
+ * @type {Date}
104
+ * @memberof InvoiceDto
105
+ */
106
+ payoutDueAt: Date | null;
107
+ /**
108
+ * The bank transfer a seller invoice is or was last paid out with. Null when it was in none.
109
+ * @type {InvoicePayoutDto}
110
+ * @memberof InvoiceDto
111
+ */
112
+ payout: InvoicePayoutDto | null;
100
113
  }
101
114
  /**
102
115
  * @export
@@ -21,6 +21,7 @@ exports.InvoiceDtoToJSON = InvoiceDtoToJSON;
21
21
  exports.InvoiceDtoToJSONTyped = InvoiceDtoToJSONTyped;
22
22
  var InvoiceDomainDto_1 = require("./InvoiceDomainDto");
23
23
  var InvoiceSellerAccountDto_1 = require("./InvoiceSellerAccountDto");
24
+ var InvoicePayoutDto_1 = require("./InvoicePayoutDto");
24
25
  var MoneyDto_1 = require("./MoneyDto");
25
26
  var InvoiceDtoTransaction_1 = require("./InvoiceDtoTransaction");
26
27
  /**
@@ -69,6 +70,10 @@ function instanceOfInvoiceDto(value) {
69
70
  return false;
70
71
  if (!('transaction' in value) || value['transaction'] === undefined)
71
72
  return false;
73
+ if (!('payoutDueAt' in value) || value['payoutDueAt'] === undefined)
74
+ return false;
75
+ if (!('payout' in value) || value['payout'] === undefined)
76
+ return false;
72
77
  return true;
73
78
  }
74
79
  function InvoiceDtoFromJSON(json) {
@@ -92,6 +97,8 @@ function InvoiceDtoFromJSONTyped(json, ignoreDiscriminator) {
92
97
  'isAffiliateCommission': json['isAffiliateCommission'],
93
98
  'buyerEmail': json['buyerEmail'],
94
99
  'transaction': (0, InvoiceDtoTransaction_1.InvoiceDtoTransactionFromJSON)(json['transaction']),
100
+ 'payoutDueAt': (json['payoutDueAt'] == null ? null : new Date(json['payoutDueAt'])),
101
+ 'payout': (0, InvoicePayoutDto_1.InvoicePayoutDtoFromJSON)(json['payout']),
95
102
  };
96
103
  }
97
104
  function InvoiceDtoToJSON(json) {
@@ -116,5 +123,7 @@ function InvoiceDtoToJSONTyped(value, ignoreDiscriminator) {
116
123
  'isAffiliateCommission': value['isAffiliateCommission'],
117
124
  'buyerEmail': value['buyerEmail'],
118
125
  'transaction': (0, InvoiceDtoTransaction_1.InvoiceDtoTransactionToJSON)(value['transaction']),
126
+ 'payoutDueAt': (value['payoutDueAt'] == null ? null : value['payoutDueAt'].toISOString()),
127
+ 'payout': (0, InvoicePayoutDto_1.InvoicePayoutDtoToJSON)(value['payout']),
119
128
  };
120
129
  }
@@ -0,0 +1,71 @@
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 { MoneyDto } from './MoneyDto';
13
+ import type { SellerPayoutStatus } from './SellerPayoutStatus';
14
+ import type { BankAccountTransferMethod } from './BankAccountTransferMethod';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface InvoicePayoutDto
19
+ */
20
+ export interface InvoicePayoutDto {
21
+ /**
22
+ * The payout. Invoices paid out in one transfer share it.
23
+ * @type {string}
24
+ * @memberof InvoicePayoutDto
25
+ */
26
+ id: string;
27
+ /**
28
+ * pending while the transfer is being made, paid once it is, failed when the payout provider refused it: the invoice then awaits another payout.
29
+ * @type {SellerPayoutStatus}
30
+ * @memberof InvoicePayoutDto
31
+ */
32
+ status: SellerPayoutStatus;
33
+ /**
34
+ * What the payout is for: this invoice and the others paid out with it.
35
+ * @type {MoneyDto}
36
+ * @memberof InvoicePayoutDto
37
+ */
38
+ amount: MoneyDto;
39
+ /**
40
+ * How the payout reaches the bank account: LOCAL over the country's own clearing system, or SWIFT, an international transfer with a fee.
41
+ * @type {BankAccountTransferMethod}
42
+ * @memberof InvoicePayoutDto
43
+ */
44
+ transferMethod: BankAccountTransferMethod;
45
+ /**
46
+ * The transfer fee that was taken out of what the seller receives, once for the whole payout. Null when there was none.
47
+ * @type {MoneyDto}
48
+ * @memberof InvoicePayoutDto
49
+ */
50
+ fee: MoneyDto | null;
51
+ /**
52
+ * What the payout provider says arrives on the bank account, in its currency. Null when it did not say.
53
+ * @type {MoneyDto}
54
+ * @memberof InvoicePayoutDto
55
+ */
56
+ receivedAmount: MoneyDto | null;
57
+ /**
58
+ * When the transfer was made.
59
+ * @type {Date}
60
+ * @memberof InvoicePayoutDto
61
+ */
62
+ paidAt: Date | null;
63
+ }
64
+ /**
65
+ * Check if a given object implements the InvoicePayoutDto interface.
66
+ */
67
+ export declare function instanceOfInvoicePayoutDto(value: object): value is InvoicePayoutDto;
68
+ export declare function InvoicePayoutDtoFromJSON(json: any): InvoicePayoutDto;
69
+ export declare function InvoicePayoutDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoicePayoutDto;
70
+ export declare function InvoicePayoutDtoToJSON(json: any): InvoicePayoutDto;
71
+ export declare function InvoicePayoutDtoToJSONTyped(value?: InvoicePayoutDto | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,78 @@
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.instanceOfInvoicePayoutDto = instanceOfInvoicePayoutDto;
17
+ exports.InvoicePayoutDtoFromJSON = InvoicePayoutDtoFromJSON;
18
+ exports.InvoicePayoutDtoFromJSONTyped = InvoicePayoutDtoFromJSONTyped;
19
+ exports.InvoicePayoutDtoToJSON = InvoicePayoutDtoToJSON;
20
+ exports.InvoicePayoutDtoToJSONTyped = InvoicePayoutDtoToJSONTyped;
21
+ var MoneyDto_1 = require("./MoneyDto");
22
+ var SellerPayoutStatus_1 = require("./SellerPayoutStatus");
23
+ var BankAccountTransferMethod_1 = require("./BankAccountTransferMethod");
24
+ /**
25
+ * Check if a given object implements the InvoicePayoutDto interface.
26
+ */
27
+ function instanceOfInvoicePayoutDto(value) {
28
+ if (!('id' in value) || value['id'] === undefined)
29
+ return false;
30
+ if (!('status' in value) || value['status'] === undefined)
31
+ return false;
32
+ if (!('amount' in value) || value['amount'] === undefined)
33
+ return false;
34
+ if (!('transferMethod' in value) || value['transferMethod'] === undefined)
35
+ return false;
36
+ if (!('fee' in value) || value['fee'] === undefined)
37
+ return false;
38
+ if (!('receivedAmount' in value) || value['receivedAmount'] === undefined)
39
+ return false;
40
+ if (!('paidAt' in value) || value['paidAt'] === undefined)
41
+ return false;
42
+ return true;
43
+ }
44
+ function InvoicePayoutDtoFromJSON(json) {
45
+ return InvoicePayoutDtoFromJSONTyped(json, false);
46
+ }
47
+ function InvoicePayoutDtoFromJSONTyped(json, ignoreDiscriminator) {
48
+ if (json == null) {
49
+ return json;
50
+ }
51
+ return {
52
+ 'id': json['id'],
53
+ 'status': (0, SellerPayoutStatus_1.SellerPayoutStatusFromJSON)(json['status']),
54
+ 'amount': (0, MoneyDto_1.MoneyDtoFromJSON)(json['amount']),
55
+ 'transferMethod': (0, BankAccountTransferMethod_1.BankAccountTransferMethodFromJSON)(json['transferMethod']),
56
+ 'fee': (0, MoneyDto_1.MoneyDtoFromJSON)(json['fee']),
57
+ 'receivedAmount': (0, MoneyDto_1.MoneyDtoFromJSON)(json['receivedAmount']),
58
+ 'paidAt': (json['paidAt'] == null ? null : new Date(json['paidAt'])),
59
+ };
60
+ }
61
+ function InvoicePayoutDtoToJSON(json) {
62
+ return InvoicePayoutDtoToJSONTyped(json, false);
63
+ }
64
+ function InvoicePayoutDtoToJSONTyped(value, ignoreDiscriminator) {
65
+ if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
66
+ if (value == null) {
67
+ return value;
68
+ }
69
+ return {
70
+ 'id': value['id'],
71
+ 'status': (0, SellerPayoutStatus_1.SellerPayoutStatusToJSON)(value['status']),
72
+ 'amount': (0, MoneyDto_1.MoneyDtoToJSON)(value['amount']),
73
+ 'transferMethod': (0, BankAccountTransferMethod_1.BankAccountTransferMethodToJSON)(value['transferMethod']),
74
+ 'fee': (0, MoneyDto_1.MoneyDtoToJSON)(value['fee']),
75
+ 'receivedAmount': (0, MoneyDto_1.MoneyDtoToJSON)(value['receivedAmount']),
76
+ 'paidAt': (value['paidAt'] == null ? null : value['paidAt'].toISOString()),
77
+ };
78
+ }
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { PayoutFrequency } from './PayoutFrequency';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -45,6 +46,18 @@ export interface InvoiceSellerAccountDto {
45
46
  * @memberof InvoiceSellerAccountDto
46
47
  */
47
48
  payoutProvider: InvoiceSellerAccountDtoPayoutProviderEnum;
49
+ /**
50
+ * How often the seller wants to be paid out: their invoices are due accordingly.
51
+ * @type {PayoutFrequency}
52
+ * @memberof InvoiceSellerAccountDto
53
+ */
54
+ payoutFrequency: PayoutFrequency;
55
+ /**
56
+ * Whether the invoices of this seller are paid out without an admin once they are due.
57
+ * @type {boolean}
58
+ * @memberof InvoiceSellerAccountDto
59
+ */
60
+ automaticPayouts: boolean;
48
61
  }
49
62
  /**
50
63
  * @export
@@ -19,6 +19,7 @@ exports.InvoiceSellerAccountDtoFromJSON = InvoiceSellerAccountDtoFromJSON;
19
19
  exports.InvoiceSellerAccountDtoFromJSONTyped = InvoiceSellerAccountDtoFromJSONTyped;
20
20
  exports.InvoiceSellerAccountDtoToJSON = InvoiceSellerAccountDtoToJSON;
21
21
  exports.InvoiceSellerAccountDtoToJSONTyped = InvoiceSellerAccountDtoToJSONTyped;
22
+ var PayoutFrequency_1 = require("./PayoutFrequency");
22
23
  /**
23
24
  * @export
24
25
  */
@@ -40,6 +41,10 @@ function instanceOfInvoiceSellerAccountDto(value) {
40
41
  return false;
41
42
  if (!('payoutProvider' in value) || value['payoutProvider'] === undefined)
42
43
  return false;
44
+ if (!('payoutFrequency' in value) || value['payoutFrequency'] === undefined)
45
+ return false;
46
+ if (!('automaticPayouts' in value) || value['automaticPayouts'] === undefined)
47
+ return false;
43
48
  return true;
44
49
  }
45
50
  function InvoiceSellerAccountDtoFromJSON(json) {
@@ -55,6 +60,8 @@ function InvoiceSellerAccountDtoFromJSONTyped(json, ignoreDiscriminator) {
55
60
  'name': json['name'],
56
61
  'isBusiness': json['isBusiness'],
57
62
  'payoutProvider': json['payoutProvider'],
63
+ 'payoutFrequency': (0, PayoutFrequency_1.PayoutFrequencyFromJSON)(json['payoutFrequency']),
64
+ 'automaticPayouts': json['automaticPayouts'],
58
65
  };
59
66
  }
60
67
  function InvoiceSellerAccountDtoToJSON(json) {
@@ -71,5 +78,7 @@ function InvoiceSellerAccountDtoToJSONTyped(value, ignoreDiscriminator) {
71
78
  'name': value['name'],
72
79
  'isBusiness': value['isBusiness'],
73
80
  'payoutProvider': value['payoutProvider'],
81
+ 'payoutFrequency': (0, PayoutFrequency_1.PayoutFrequencyToJSON)(value['payoutFrequency']),
82
+ 'automaticPayouts': value['automaticPayouts'],
74
83
  };
75
84
  }
@@ -0,0 +1,32 @@
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface PaySellerInvoicesInput
16
+ */
17
+ export interface PaySellerInvoicesInput {
18
+ /**
19
+ * The seller invoices to pay out together: all of one seller, awaiting their payout and, for a bank transfer, in one currency.
20
+ * @type {Array<string>}
21
+ * @memberof PaySellerInvoicesInput
22
+ */
23
+ invoiceIds: Array<string>;
24
+ }
25
+ /**
26
+ * Check if a given object implements the PaySellerInvoicesInput interface.
27
+ */
28
+ export declare function instanceOfPaySellerInvoicesInput(value: object): value is PaySellerInvoicesInput;
29
+ export declare function PaySellerInvoicesInputFromJSON(json: any): PaySellerInvoicesInput;
30
+ export declare function PaySellerInvoicesInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaySellerInvoicesInput;
31
+ export declare function PaySellerInvoicesInputToJSON(json: any): PaySellerInvoicesInput;
32
+ export declare function PaySellerInvoicesInputToJSONTyped(value?: PaySellerInvoicesInput | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
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.instanceOfPaySellerInvoicesInput = instanceOfPaySellerInvoicesInput;
17
+ exports.PaySellerInvoicesInputFromJSON = PaySellerInvoicesInputFromJSON;
18
+ exports.PaySellerInvoicesInputFromJSONTyped = PaySellerInvoicesInputFromJSONTyped;
19
+ exports.PaySellerInvoicesInputToJSON = PaySellerInvoicesInputToJSON;
20
+ exports.PaySellerInvoicesInputToJSONTyped = PaySellerInvoicesInputToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the PaySellerInvoicesInput interface.
23
+ */
24
+ function instanceOfPaySellerInvoicesInput(value) {
25
+ if (!('invoiceIds' in value) || value['invoiceIds'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function PaySellerInvoicesInputFromJSON(json) {
30
+ return PaySellerInvoicesInputFromJSONTyped(json, false);
31
+ }
32
+ function PaySellerInvoicesInputFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'invoiceIds': json['invoiceIds'],
38
+ };
39
+ }
40
+ function PaySellerInvoicesInputToJSON(json) {
41
+ return PaySellerInvoicesInputToJSONTyped(json, false);
42
+ }
43
+ function PaySellerInvoicesInputToJSONTyped(value, ignoreDiscriminator) {
44
+ if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'invoiceIds': value['invoiceIds'],
50
+ };
51
+ }
@@ -0,0 +1,28 @@
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
+ /**
13
+ * How often the seller is paid out when they are paid out automatically: each invoice as soon as it can be (immediate), or what came in during a week, two weeks, month or quarter when the next one starts. An admin pays out the others, whatever this says.
14
+ * @export
15
+ */
16
+ export declare const PayoutFrequency: {
17
+ readonly IMMEDIATE: "immediate";
18
+ readonly WEEKLY: "weekly";
19
+ readonly BIWEEKLY: "biweekly";
20
+ readonly MONTHLY: "monthly";
21
+ readonly QUARTERLY: "quarterly";
22
+ };
23
+ export type PayoutFrequency = typeof PayoutFrequency[keyof typeof PayoutFrequency];
24
+ export declare function instanceOfPayoutFrequency(value: any): boolean;
25
+ export declare function PayoutFrequencyFromJSON(json: any): PayoutFrequency;
26
+ export declare function PayoutFrequencyFromJSONTyped(json: any, ignoreDiscriminator: boolean): PayoutFrequency;
27
+ export declare function PayoutFrequencyToJSON(value?: PayoutFrequency | null): any;
28
+ export declare function PayoutFrequencyToJSONTyped(value: any, ignoreDiscriminator: boolean): PayoutFrequency;
@@ -0,0 +1,54 @@
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.PayoutFrequency = void 0;
17
+ exports.instanceOfPayoutFrequency = instanceOfPayoutFrequency;
18
+ exports.PayoutFrequencyFromJSON = PayoutFrequencyFromJSON;
19
+ exports.PayoutFrequencyFromJSONTyped = PayoutFrequencyFromJSONTyped;
20
+ exports.PayoutFrequencyToJSON = PayoutFrequencyToJSON;
21
+ exports.PayoutFrequencyToJSONTyped = PayoutFrequencyToJSONTyped;
22
+ /**
23
+ * How often the seller is paid out when they are paid out automatically: each invoice as soon as it can be (immediate), or what came in during a week, two weeks, month or quarter when the next one starts. An admin pays out the others, whatever this says.
24
+ * @export
25
+ */
26
+ exports.PayoutFrequency = {
27
+ IMMEDIATE: 'immediate',
28
+ WEEKLY: 'weekly',
29
+ BIWEEKLY: 'biweekly',
30
+ MONTHLY: 'monthly',
31
+ QUARTERLY: 'quarterly'
32
+ };
33
+ function instanceOfPayoutFrequency(value) {
34
+ for (var key in exports.PayoutFrequency) {
35
+ if (Object.prototype.hasOwnProperty.call(exports.PayoutFrequency, key)) {
36
+ if (exports.PayoutFrequency[key] === value) {
37
+ return true;
38
+ }
39
+ }
40
+ }
41
+ return false;
42
+ }
43
+ function PayoutFrequencyFromJSON(json) {
44
+ return PayoutFrequencyFromJSONTyped(json, false);
45
+ }
46
+ function PayoutFrequencyFromJSONTyped(json, ignoreDiscriminator) {
47
+ return json;
48
+ }
49
+ function PayoutFrequencyToJSON(value) {
50
+ return value;
51
+ }
52
+ function PayoutFrequencyToJSONTyped(value, ignoreDiscriminator) {
53
+ return value;
54
+ }
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import type { SellerInvoiceDomainDto } from './SellerInvoiceDomainDto';
13
13
  import type { SellerInvoiceSellerAccountDto } from './SellerInvoiceSellerAccountDto';
14
+ import type { InvoicePayoutDto } from './InvoicePayoutDto';
14
15
  import type { MoneyDto } from './MoneyDto';
15
16
  /**
16
17
  *
@@ -84,6 +85,18 @@ export interface SellerInvoiceDto {
84
85
  * @memberof SellerInvoiceDto
85
86
  */
86
87
  isAffiliateCommission: boolean;
88
+ /**
89
+ * For an invoice awaiting its payout: when it is due, by the payout frequency of the account. A payout that costs the account nothing is due right away, unless it wants those to wait too, and so is every invoice of an account that is not paid out automatically. Null when it awaits no payout.
90
+ * @type {Date}
91
+ * @memberof SellerInvoiceDto
92
+ */
93
+ payoutDueAt: Date | null;
94
+ /**
95
+ * The bank transfer the invoice is or was last paid out with, which tells the transfer fee taken out of it. Null when it was in none.
96
+ * @type {InvoicePayoutDto}
97
+ * @memberof SellerInvoiceDto
98
+ */
99
+ payout: InvoicePayoutDto | null;
87
100
  }
88
101
  /**
89
102
  * @export
@@ -21,6 +21,7 @@ exports.SellerInvoiceDtoToJSON = SellerInvoiceDtoToJSON;
21
21
  exports.SellerInvoiceDtoToJSONTyped = SellerInvoiceDtoToJSONTyped;
22
22
  var SellerInvoiceDomainDto_1 = require("./SellerInvoiceDomainDto");
23
23
  var SellerInvoiceSellerAccountDto_1 = require("./SellerInvoiceSellerAccountDto");
24
+ var InvoicePayoutDto_1 = require("./InvoicePayoutDto");
24
25
  var MoneyDto_1 = require("./MoneyDto");
25
26
  /**
26
27
  * @export
@@ -64,6 +65,10 @@ function instanceOfSellerInvoiceDto(value) {
64
65
  return false;
65
66
  if (!('isAffiliateCommission' in value) || value['isAffiliateCommission'] === undefined)
66
67
  return false;
68
+ if (!('payoutDueAt' in value) || value['payoutDueAt'] === undefined)
69
+ return false;
70
+ if (!('payout' in value) || value['payout'] === undefined)
71
+ return false;
67
72
  return true;
68
73
  }
69
74
  function SellerInvoiceDtoFromJSON(json) {
@@ -85,6 +90,8 @@ function SellerInvoiceDtoFromJSONTyped(json, ignoreDiscriminator) {
85
90
  'parent': json['parent'],
86
91
  'hasChildren': json['hasChildren'],
87
92
  'isAffiliateCommission': json['isAffiliateCommission'],
93
+ 'payoutDueAt': (json['payoutDueAt'] == null ? null : new Date(json['payoutDueAt'])),
94
+ 'payout': (0, InvoicePayoutDto_1.InvoicePayoutDtoFromJSON)(json['payout']),
88
95
  };
89
96
  }
90
97
  function SellerInvoiceDtoToJSON(json) {
@@ -107,5 +114,7 @@ function SellerInvoiceDtoToJSONTyped(value, ignoreDiscriminator) {
107
114
  'parent': value['parent'],
108
115
  'hasChildren': value['hasChildren'],
109
116
  'isAffiliateCommission': value['isAffiliateCommission'],
117
+ 'payoutDueAt': (value['payoutDueAt'] == null ? null : value['payoutDueAt'].toISOString()),
118
+ 'payout': (0, InvoicePayoutDto_1.InvoicePayoutDtoToJSON)(value['payout']),
110
119
  };
111
120
  }