@rippling/rippling-sdk 0.2.0-alpha.96 → 0.2.0-alpha.98

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 (113) hide show
  1. package/client.d.mts +37 -4
  2. package/client.d.mts.map +1 -1
  3. package/client.d.ts +37 -4
  4. package/client.d.ts.map +1 -1
  5. package/client.js +33 -0
  6. package/client.js.map +1 -1
  7. package/client.mjs +34 -1
  8. package/client.mjs.map +1 -1
  9. package/package.json +2 -1
  10. package/resources/draft-transitions.d.mts +474 -0
  11. package/resources/draft-transitions.d.mts.map +1 -0
  12. package/resources/draft-transitions.d.ts +474 -0
  13. package/resources/draft-transitions.d.ts.map +1 -0
  14. package/resources/draft-transitions.js +25 -0
  15. package/resources/draft-transitions.js.map +1 -0
  16. package/resources/draft-transitions.mjs +21 -0
  17. package/resources/draft-transitions.mjs.map +1 -0
  18. package/resources/index.d.mts +7 -2
  19. package/resources/index.d.mts.map +1 -1
  20. package/resources/index.d.ts +7 -2
  21. package/resources/index.d.ts.map +1 -1
  22. package/resources/index.js +12 -2
  23. package/resources/index.js.map +1 -1
  24. package/resources/index.mjs +6 -1
  25. package/resources/index.mjs.map +1 -1
  26. package/resources/metadata/index.d.mts +1 -1
  27. package/resources/metadata/index.d.mts.map +1 -1
  28. package/resources/metadata/index.d.ts +1 -1
  29. package/resources/metadata/index.d.ts.map +1 -1
  30. package/resources/metadata/index.js.map +1 -1
  31. package/resources/metadata/index.mjs +1 -1
  32. package/resources/metadata/index.mjs.map +1 -1
  33. package/resources/metadata/metadata.d.mts +47 -1
  34. package/resources/metadata/metadata.d.mts.map +1 -1
  35. package/resources/metadata/metadata.d.ts +47 -1
  36. package/resources/metadata/metadata.d.ts.map +1 -1
  37. package/resources/metadata/metadata.js +15 -0
  38. package/resources/metadata/metadata.js.map +1 -1
  39. package/resources/metadata/metadata.mjs +15 -0
  40. package/resources/metadata/metadata.mjs.map +1 -1
  41. package/resources/package-managed-installs.d.mts +119 -0
  42. package/resources/package-managed-installs.d.mts.map +1 -0
  43. package/resources/package-managed-installs.d.ts +119 -0
  44. package/resources/package-managed-installs.d.ts.map +1 -0
  45. package/resources/package-managed-installs.js +26 -0
  46. package/resources/package-managed-installs.js.map +1 -0
  47. package/resources/package-managed-installs.mjs +22 -0
  48. package/resources/package-managed-installs.mjs.map +1 -0
  49. package/resources/sandboxes.d.mts +224 -1
  50. package/resources/sandboxes.d.mts.map +1 -1
  51. package/resources/sandboxes.d.ts +224 -1
  52. package/resources/sandboxes.d.ts.map +1 -1
  53. package/resources/sandboxes.js +6 -0
  54. package/resources/sandboxes.js.map +1 -1
  55. package/resources/sandboxes.mjs +6 -0
  56. package/resources/sandboxes.mjs.map +1 -1
  57. package/resources/sites.d.mts +3 -0
  58. package/resources/sites.d.mts.map +1 -1
  59. package/resources/sites.d.ts +3 -0
  60. package/resources/sites.d.ts.map +1 -1
  61. package/resources/sites.js +3 -0
  62. package/resources/sites.js.map +1 -1
  63. package/resources/sites.mjs +3 -0
  64. package/resources/sites.mjs.map +1 -1
  65. package/resources/variable-compensation-payout-labels.d.mts +155 -0
  66. package/resources/variable-compensation-payout-labels.d.mts.map +1 -0
  67. package/resources/variable-compensation-payout-labels.d.ts +155 -0
  68. package/resources/variable-compensation-payout-labels.d.ts.map +1 -0
  69. package/resources/variable-compensation-payout-labels.js +41 -0
  70. package/resources/variable-compensation-payout-labels.js.map +1 -0
  71. package/resources/variable-compensation-payout-labels.mjs +37 -0
  72. package/resources/variable-compensation-payout-labels.mjs.map +1 -0
  73. package/resources/variable-compensation-payout-types.d.mts +334 -0
  74. package/resources/variable-compensation-payout-types.d.mts.map +1 -0
  75. package/resources/variable-compensation-payout-types.d.ts +334 -0
  76. package/resources/variable-compensation-payout-types.d.ts.map +1 -0
  77. package/resources/variable-compensation-payout-types.js +52 -0
  78. package/resources/variable-compensation-payout-types.js.map +1 -0
  79. package/resources/variable-compensation-payout-types.mjs +48 -0
  80. package/resources/variable-compensation-payout-types.mjs.map +1 -0
  81. package/resources/variable-compensation-payout-writes.d.mts +6 -17
  82. package/resources/variable-compensation-payout-writes.d.mts.map +1 -1
  83. package/resources/variable-compensation-payout-writes.d.ts +6 -17
  84. package/resources/variable-compensation-payout-writes.d.ts.map +1 -1
  85. package/resources/variable-compensation-payout-writes.js +2 -1
  86. package/resources/variable-compensation-payout-writes.js.map +1 -1
  87. package/resources/variable-compensation-payout-writes.mjs +2 -1
  88. package/resources/variable-compensation-payout-writes.mjs.map +1 -1
  89. package/resources/variable-compensation-payouts.d.mts +501 -0
  90. package/resources/variable-compensation-payouts.d.mts.map +1 -0
  91. package/resources/variable-compensation-payouts.d.ts +501 -0
  92. package/resources/variable-compensation-payouts.d.ts.map +1 -0
  93. package/resources/variable-compensation-payouts.js +41 -0
  94. package/resources/variable-compensation-payouts.js.map +1 -0
  95. package/resources/variable-compensation-payouts.mjs +37 -0
  96. package/resources/variable-compensation-payouts.mjs.map +1 -0
  97. package/src/client.ts +130 -1
  98. package/src/resources/draft-transitions.ts +583 -0
  99. package/src/resources/index.ts +50 -1
  100. package/src/resources/metadata/index.ts +7 -1
  101. package/src/resources/metadata/metadata.ts +54 -0
  102. package/src/resources/package-managed-installs.ts +156 -0
  103. package/src/resources/sandboxes.ts +265 -0
  104. package/src/resources/sites.ts +3 -0
  105. package/src/resources/variable-compensation-payout-labels.ts +227 -0
  106. package/src/resources/variable-compensation-payout-types.ts +440 -0
  107. package/src/resources/variable-compensation-payout-writes.ts +6 -20
  108. package/src/resources/variable-compensation-payouts.ts +702 -0
  109. package/src/version.ts +1 -1
  110. package/version.d.mts +1 -1
  111. package/version.d.ts +1 -1
  112. package/version.js +1 -1
  113. package/version.mjs +1 -1
@@ -0,0 +1,155 @@
1
+ import { APIResource } from "../core/resource.js";
2
+ import * as BusinessPartnersAPI from "./business-partners.js";
3
+ import { APIPromise } from "../core/api-promise.js";
4
+ import { PageCursorURL, PagePromise } from "../core/pagination.js";
5
+ import { RequestOptions } from "../internal/request-options.js";
6
+ /**
7
+ * Compensation associated with workers
8
+ */
9
+ export declare class VariableCompensationPayoutLabels extends APIResource {
10
+ /**
11
+ * A list of variable compensation payout labels.
12
+ *
13
+ * - Requires: `API Tier 1`
14
+ */
15
+ list(query?: VariableCompensationPayoutLabelListParams | null | undefined, options?: RequestOptions): PagePromise<VariableCompensationPayoutLabelListResponsesPageCursorURL, VariableCompensationPayoutLabelListResponse>;
16
+ /**
17
+ * Get or create a source or group label. Identity is (client, external_id). New
18
+ * identities return 201; an existing match returns 200.
19
+ */
20
+ create(body: VariableCompensationPayoutLabelCreateParams, options?: RequestOptions): APIPromise<VariableCompensationPayoutLabelCreateResponse>;
21
+ /**
22
+ * Retrieve a specific payout source or group label.
23
+ */
24
+ retrieve(id: string, options?: RequestOptions): APIPromise<VariableCompensationPayoutLabelRetrieveResponse>;
25
+ /**
26
+ * Update a specific variable compensation payout label.
27
+ */
28
+ update(id: string, body: VariableCompensationPayoutLabelUpdateParams, options?: RequestOptions): APIPromise<VariableCompensationPayoutLabelUpdateResponse>;
29
+ }
30
+ export type VariableCompensationPayoutLabelListResponsesPageCursorURL = PageCursorURL<VariableCompensationPayoutLabelListResponse>;
31
+ export interface VariableCompensationPayoutLabelListResponse {
32
+ /**
33
+ * Unique identifier of the payout label.
34
+ */
35
+ id: string;
36
+ /**
37
+ * Client system that created the label.
38
+ */
39
+ client: string;
40
+ /**
41
+ * External identifier unique per company and client.
42
+ */
43
+ external_id: string;
44
+ /**
45
+ * Display name of the label.
46
+ */
47
+ name: string;
48
+ }
49
+ export interface VariableCompensationPayoutLabelCreateResponse {
50
+ /**
51
+ * Unique identifier of the payout label.
52
+ */
53
+ id: string;
54
+ /**
55
+ * Client system that created the label.
56
+ */
57
+ client: string;
58
+ /**
59
+ * External identifier unique per company and client.
60
+ */
61
+ external_id: string;
62
+ /**
63
+ * Display name of the label.
64
+ */
65
+ name: string;
66
+ }
67
+ /**
68
+ * Meta information for the response.
69
+ */
70
+ export interface VariableCompensationPayoutLabelRetrieveResponse extends BusinessPartnersAPI.Meta {
71
+ /**
72
+ * Unique identifier of the payout label.
73
+ */
74
+ id: string;
75
+ /**
76
+ * Client system that created the label.
77
+ */
78
+ client: string;
79
+ /**
80
+ * External identifier unique per company and client.
81
+ */
82
+ external_id: string;
83
+ /**
84
+ * Display name of the label.
85
+ */
86
+ name: string;
87
+ }
88
+ export interface VariableCompensationPayoutLabelUpdateResponse {
89
+ /**
90
+ * Unique identifier of the payout label.
91
+ */
92
+ id: string;
93
+ /**
94
+ * Client system that created the label.
95
+ */
96
+ client: string;
97
+ /**
98
+ * External identifier unique per company and client.
99
+ */
100
+ external_id: string;
101
+ /**
102
+ * Display name of the label.
103
+ */
104
+ name: string;
105
+ }
106
+ export interface VariableCompensationPayoutLabelListParams {
107
+ /**
108
+ * Client system that created the label.
109
+ */
110
+ client?: string;
111
+ /**
112
+ * Opaque pagination cursor from the previous page's next_link.
113
+ */
114
+ cursor?: string;
115
+ /**
116
+ * External identifier unique per company and client.
117
+ */
118
+ external_id?: string;
119
+ /**
120
+ * Page size. Defaults to 50. Maximum 100.
121
+ */
122
+ limit?: number;
123
+ }
124
+ export interface VariableCompensationPayoutLabelCreateParams {
125
+ /**
126
+ * Client system that created the label.
127
+ */
128
+ client: string;
129
+ /**
130
+ * External identifier unique per company and client.
131
+ */
132
+ external_id: string;
133
+ /**
134
+ * Display name of the label.
135
+ */
136
+ name: string;
137
+ }
138
+ export interface VariableCompensationPayoutLabelUpdateParams {
139
+ /**
140
+ * Client system that created the label.
141
+ */
142
+ client: string;
143
+ /**
144
+ * External identifier unique per company and client.
145
+ */
146
+ external_id: string;
147
+ /**
148
+ * Display name of the label.
149
+ */
150
+ name: string;
151
+ }
152
+ export declare namespace VariableCompensationPayoutLabels {
153
+ export { type VariableCompensationPayoutLabelListResponse as VariableCompensationPayoutLabelListResponse, type VariableCompensationPayoutLabelCreateResponse as VariableCompensationPayoutLabelCreateResponse, type VariableCompensationPayoutLabelRetrieveResponse as VariableCompensationPayoutLabelRetrieveResponse, type VariableCompensationPayoutLabelUpdateResponse as VariableCompensationPayoutLabelUpdateResponse, type VariableCompensationPayoutLabelListResponsesPageCursorURL as VariableCompensationPayoutLabelListResponsesPageCursorURL, type VariableCompensationPayoutLabelListParams as VariableCompensationPayoutLabelListParams, type VariableCompensationPayoutLabelCreateParams as VariableCompensationPayoutLabelCreateParams, type VariableCompensationPayoutLabelUpdateParams as VariableCompensationPayoutLabelUpdateParams, };
154
+ }
155
+ //# sourceMappingURL=variable-compensation-payout-labels.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"variable-compensation-payout-labels.d.ts","sourceRoot":"","sources":["../src/resources/variable-compensation-payout-labels.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,gCAAiC,SAAQ,WAAW;IAC/D;;;;OAIG;IACH,IAAI,CACF,KAAK,GAAE,yCAAyC,GAAG,IAAI,GAAG,SAAc,EACxE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CACZ,yDAAyD,EACzD,2CAA2C,CAC5C;IAQD;;;OAGG;IACH,MAAM,CACJ,IAAI,EAAE,2CAA2C,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6CAA6C,CAAC;IAI5D;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+CAA+C,CAAC;IAI9D;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,2CAA2C,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6CAA6C,CAAC;CAG7D;AAED,MAAM,MAAM,yDAAyD,GACnE,aAAa,CAAC,2CAA2C,CAAC,CAAC;AAE7D,MAAM,WAAW,2CAA2C;IAC1D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,6CAA6C;IAC5D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,+CAAgD,SAAQ,mBAAmB,CAAC,IAAI;IAC/F;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,6CAA6C;IAC5D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,yCAAyC;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,2CAA2C;IAC1D;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,2CAA2C;IAC1D;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,gCAAgC,CAAC;IACxD,OAAO,EACL,KAAK,2CAA2C,IAAI,2CAA2C,EAC/F,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,+CAA+C,IAAI,+CAA+C,EACvG,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,yDAAyD,IAAI,yDAAyD,EAC3H,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,2CAA2C,IAAI,2CAA2C,EAC/F,KAAK,2CAA2C,IAAI,2CAA2C,GAChG,CAAC;CACH"}
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.VariableCompensationPayoutLabels = void 0;
5
+ const resource_1 = require("../core/resource.js");
6
+ const pagination_1 = require("../core/pagination.js");
7
+ const path_1 = require("../internal/utils/path.js");
8
+ /**
9
+ * Compensation associated with workers
10
+ */
11
+ class VariableCompensationPayoutLabels extends resource_1.APIResource {
12
+ /**
13
+ * A list of variable compensation payout labels.
14
+ *
15
+ * - Requires: `API Tier 1`
16
+ */
17
+ list(query = {}, options) {
18
+ return this._client.getAPIList('/variable-compensation-payout-labels/', (pagination_1.PageCursorURL), { query, ...options });
19
+ }
20
+ /**
21
+ * Get or create a source or group label. Identity is (client, external_id). New
22
+ * identities return 201; an existing match returns 200.
23
+ */
24
+ create(body, options) {
25
+ return this._client.post('/variable-compensation-payout-labels/', { body, ...options });
26
+ }
27
+ /**
28
+ * Retrieve a specific payout source or group label.
29
+ */
30
+ retrieve(id, options) {
31
+ return this._client.get((0, path_1.path) `/variable-compensation-payout-labels/${id}/`, options);
32
+ }
33
+ /**
34
+ * Update a specific variable compensation payout label.
35
+ */
36
+ update(id, body, options) {
37
+ return this._client.patch((0, path_1.path) `/variable-compensation-payout-labels/${id}/`, { body, ...options });
38
+ }
39
+ }
40
+ exports.VariableCompensationPayoutLabels = VariableCompensationPayoutLabels;
41
+ //# sourceMappingURL=variable-compensation-payout-labels.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"variable-compensation-payout-labels.js","sourceRoot":"","sources":["../src/resources/variable-compensation-payout-labels.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,gCAAiC,SAAQ,sBAAW;IAC/D;;;;OAIG;IACH,IAAI,CACF,QAAsE,EAAE,EACxE,OAAwB;QAKxB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,uCAAuC,EACvC,CAAA,0BAA0D,CAAA,EAC1D,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,IAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wCAAwC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,IAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,wCAAwC,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF;AAnDD,4EAmDC"}
@@ -0,0 +1,37 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../core/resource.mjs";
3
+ import { PageCursorURL } from "../core/pagination.mjs";
4
+ import { path } from "../internal/utils/path.mjs";
5
+ /**
6
+ * Compensation associated with workers
7
+ */
8
+ export class VariableCompensationPayoutLabels extends APIResource {
9
+ /**
10
+ * A list of variable compensation payout labels.
11
+ *
12
+ * - Requires: `API Tier 1`
13
+ */
14
+ list(query = {}, options) {
15
+ return this._client.getAPIList('/variable-compensation-payout-labels/', (PageCursorURL), { query, ...options });
16
+ }
17
+ /**
18
+ * Get or create a source or group label. Identity is (client, external_id). New
19
+ * identities return 201; an existing match returns 200.
20
+ */
21
+ create(body, options) {
22
+ return this._client.post('/variable-compensation-payout-labels/', { body, ...options });
23
+ }
24
+ /**
25
+ * Retrieve a specific payout source or group label.
26
+ */
27
+ retrieve(id, options) {
28
+ return this._client.get(path `/variable-compensation-payout-labels/${id}/`, options);
29
+ }
30
+ /**
31
+ * Update a specific variable compensation payout label.
32
+ */
33
+ update(id, body, options) {
34
+ return this._client.patch(path `/variable-compensation-payout-labels/${id}/`, { body, ...options });
35
+ }
36
+ }
37
+ //# sourceMappingURL=variable-compensation-payout-labels.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"variable-compensation-payout-labels.mjs","sourceRoot":"","sources":["../src/resources/variable-compensation-payout-labels.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,gCAAiC,SAAQ,WAAW;IAC/D;;;;OAIG;IACH,IAAI,CACF,QAAsE,EAAE,EACxE,OAAwB;QAKxB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,uCAAuC,EACvC,CAAA,aAA0D,CAAA,EAC1D,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,IAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wCAAwC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,IAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,wCAAwC,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF"}
@@ -0,0 +1,334 @@
1
+ import { APIResource } from "../core/resource.mjs";
2
+ import * as BusinessPartnersAPI from "./business-partners.mjs";
3
+ import { APIPromise } from "../core/api-promise.mjs";
4
+ import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
5
+ import { RequestOptions } from "../internal/request-options.mjs";
6
+ /**
7
+ * Compensation associated with workers
8
+ */
9
+ export declare class VariableCompensationPayoutTypes extends APIResource {
10
+ /**
11
+ * A list of variable compensation payout types.
12
+ *
13
+ * - Requires: `API Tier 1`
14
+ */
15
+ list(options?: RequestOptions): PagePromise<VariableCompensationPayoutTypeListResponsesPageCursorURL, VariableCompensationPayoutTypeListResponse>;
16
+ /**
17
+ * Create a custom payout type. Omit key; the server assigns one. Use PATCH
18
+ * /variable-compensation-payout-types/{key}/ to update.
19
+ */
20
+ create(body: VariableCompensationPayoutTypeCreateParams, options?: RequestOptions): APIPromise<VariableCompensationPayoutTypeCreateResponse>;
21
+ /**
22
+ * Retrieve a specific variable compensation payout type by key.
23
+ */
24
+ retrieve(id: string, options?: RequestOptions): APIPromise<VariableCompensationPayoutTypeRetrieveResponse>;
25
+ /**
26
+ * Update a custom payout type's display name or per-entity earning mappings.
27
+ */
28
+ update(id: string, body: VariableCompensationPayoutTypeUpdateParams, options?: RequestOptions): APIPromise<VariableCompensationPayoutTypeUpdateResponse>;
29
+ /**
30
+ * Delete a custom payout type. Built-in payout types cannot be deleted. Returns
31
+ * 200 with a null body.
32
+ */
33
+ delete(id: string, options?: RequestOptions): APIPromise<void>;
34
+ }
35
+ export type VariableCompensationPayoutTypeListResponsesPageCursorURL = PageCursorURL<VariableCompensationPayoutTypeListResponse>;
36
+ export interface VariableCompensationPayoutTypeListResponse {
37
+ /**
38
+ * Unique identifier of the payout type. Same as key.
39
+ */
40
+ id: string;
41
+ /**
42
+ * Display name of the payout type.
43
+ */
44
+ display_name: string;
45
+ /**
46
+ * Whether this is a built-in payout type.
47
+ */
48
+ is_system: boolean;
49
+ /**
50
+ * Stable payout type key assigned by the server on create.
51
+ */
52
+ key: string;
53
+ /**
54
+ * ID of the worker who created this custom payout type.
55
+ */
56
+ created_by?: string;
57
+ /**
58
+ * Per-entity earning code mappings.
59
+ */
60
+ mappings?: Array<VariableCompensationPayoutTypeListResponse.Mapping>;
61
+ }
62
+ export declare namespace VariableCompensationPayoutTypeListResponse {
63
+ interface Mapping {
64
+ /**
65
+ * ID of the payroll entity this mapping applies to.
66
+ */
67
+ entity_id: string;
68
+ /**
69
+ * Mapping health status.
70
+ */
71
+ health: string;
72
+ /**
73
+ * Mapped earning code for the payroll entity.
74
+ */
75
+ earning_code?: string;
76
+ /**
77
+ * Display name of the mapped earning code at response time. Convenience snapshot
78
+ * for the mapping matrix; authoritative earning metadata lives in payroll, not
79
+ * this field.
80
+ */
81
+ earning_display_name?: string;
82
+ /**
83
+ * Display name of the payroll entity at response time. Convenience snapshot for
84
+ * the mapping matrix; authoritative entity data lives on payroll entities, not
85
+ * this field.
86
+ */
87
+ entity_name?: string;
88
+ }
89
+ }
90
+ export interface VariableCompensationPayoutTypeCreateResponse {
91
+ /**
92
+ * Unique identifier of the payout type. Same as key.
93
+ */
94
+ id: string;
95
+ /**
96
+ * Display name of the payout type.
97
+ */
98
+ display_name: string;
99
+ /**
100
+ * Whether this is a built-in payout type.
101
+ */
102
+ is_system: boolean;
103
+ /**
104
+ * Stable payout type key assigned by the server on create.
105
+ */
106
+ key: string;
107
+ /**
108
+ * ID of the worker who created this custom payout type.
109
+ */
110
+ created_by?: string;
111
+ /**
112
+ * Per-entity earning code mappings.
113
+ */
114
+ mappings?: Array<VariableCompensationPayoutTypeCreateResponse.Mapping>;
115
+ }
116
+ export declare namespace VariableCompensationPayoutTypeCreateResponse {
117
+ interface Mapping {
118
+ /**
119
+ * ID of the payroll entity this mapping applies to.
120
+ */
121
+ entity_id: string;
122
+ /**
123
+ * Mapping health status.
124
+ */
125
+ health: string;
126
+ /**
127
+ * Mapped earning code for the payroll entity.
128
+ */
129
+ earning_code?: string;
130
+ /**
131
+ * Display name of the mapped earning code at response time. Convenience snapshot
132
+ * for the mapping matrix; authoritative earning metadata lives in payroll, not
133
+ * this field.
134
+ */
135
+ earning_display_name?: string;
136
+ /**
137
+ * Display name of the payroll entity at response time. Convenience snapshot for
138
+ * the mapping matrix; authoritative entity data lives on payroll entities, not
139
+ * this field.
140
+ */
141
+ entity_name?: string;
142
+ }
143
+ }
144
+ /**
145
+ * Meta information for the response.
146
+ */
147
+ export interface VariableCompensationPayoutTypeRetrieveResponse extends BusinessPartnersAPI.Meta {
148
+ /**
149
+ * Unique identifier of the payout type. Same as key.
150
+ */
151
+ id: string;
152
+ /**
153
+ * Display name of the payout type.
154
+ */
155
+ display_name: string;
156
+ /**
157
+ * Whether this is a built-in payout type.
158
+ */
159
+ is_system: boolean;
160
+ /**
161
+ * Stable payout type key assigned by the server on create.
162
+ */
163
+ key: string;
164
+ /**
165
+ * ID of the worker who created this custom payout type.
166
+ */
167
+ created_by?: string;
168
+ /**
169
+ * Per-entity earning code mappings.
170
+ */
171
+ mappings?: Array<VariableCompensationPayoutTypeRetrieveResponse.Mapping>;
172
+ }
173
+ export declare namespace VariableCompensationPayoutTypeRetrieveResponse {
174
+ interface Mapping {
175
+ /**
176
+ * ID of the payroll entity this mapping applies to.
177
+ */
178
+ entity_id: string;
179
+ /**
180
+ * Mapping health status.
181
+ */
182
+ health: string;
183
+ /**
184
+ * Mapped earning code for the payroll entity.
185
+ */
186
+ earning_code?: string;
187
+ /**
188
+ * Display name of the mapped earning code at response time. Convenience snapshot
189
+ * for the mapping matrix; authoritative earning metadata lives in payroll, not
190
+ * this field.
191
+ */
192
+ earning_display_name?: string;
193
+ /**
194
+ * Display name of the payroll entity at response time. Convenience snapshot for
195
+ * the mapping matrix; authoritative entity data lives on payroll entities, not
196
+ * this field.
197
+ */
198
+ entity_name?: string;
199
+ }
200
+ }
201
+ export interface VariableCompensationPayoutTypeUpdateResponse {
202
+ /**
203
+ * Unique identifier of the payout type. Same as key.
204
+ */
205
+ id: string;
206
+ /**
207
+ * Display name of the payout type.
208
+ */
209
+ display_name: string;
210
+ /**
211
+ * Whether this is a built-in payout type.
212
+ */
213
+ is_system: boolean;
214
+ /**
215
+ * Stable payout type key assigned by the server on create.
216
+ */
217
+ key: string;
218
+ /**
219
+ * ID of the worker who created this custom payout type.
220
+ */
221
+ created_by?: string;
222
+ /**
223
+ * Per-entity earning code mappings.
224
+ */
225
+ mappings?: Array<VariableCompensationPayoutTypeUpdateResponse.Mapping>;
226
+ }
227
+ export declare namespace VariableCompensationPayoutTypeUpdateResponse {
228
+ interface Mapping {
229
+ /**
230
+ * ID of the payroll entity this mapping applies to.
231
+ */
232
+ entity_id: string;
233
+ /**
234
+ * Mapping health status.
235
+ */
236
+ health: string;
237
+ /**
238
+ * Mapped earning code for the payroll entity.
239
+ */
240
+ earning_code?: string;
241
+ /**
242
+ * Display name of the mapped earning code at response time. Convenience snapshot
243
+ * for the mapping matrix; authoritative earning metadata lives in payroll, not
244
+ * this field.
245
+ */
246
+ earning_display_name?: string;
247
+ /**
248
+ * Display name of the payroll entity at response time. Convenience snapshot for
249
+ * the mapping matrix; authoritative entity data lives on payroll entities, not
250
+ * this field.
251
+ */
252
+ entity_name?: string;
253
+ }
254
+ }
255
+ export interface VariableCompensationPayoutTypeCreateParams {
256
+ /**
257
+ * Display name of the payout type.
258
+ */
259
+ display_name: string;
260
+ /**
261
+ * Per-entity earning code mappings.
262
+ */
263
+ mappings?: Array<VariableCompensationPayoutTypeCreateParams.Mapping>;
264
+ }
265
+ export declare namespace VariableCompensationPayoutTypeCreateParams {
266
+ interface Mapping {
267
+ /**
268
+ * ID of the payroll entity this mapping applies to.
269
+ */
270
+ entity_id: string;
271
+ /**
272
+ * Mapping health status.
273
+ */
274
+ health: string;
275
+ /**
276
+ * Mapped earning code for the payroll entity.
277
+ */
278
+ earning_code?: string;
279
+ /**
280
+ * Display name of the mapped earning code at response time. Convenience snapshot
281
+ * for the mapping matrix; authoritative earning metadata lives in payroll, not
282
+ * this field.
283
+ */
284
+ earning_display_name?: string;
285
+ /**
286
+ * Display name of the payroll entity at response time. Convenience snapshot for
287
+ * the mapping matrix; authoritative entity data lives on payroll entities, not
288
+ * this field.
289
+ */
290
+ entity_name?: string;
291
+ }
292
+ }
293
+ export interface VariableCompensationPayoutTypeUpdateParams {
294
+ /**
295
+ * Display name of the payout type.
296
+ */
297
+ display_name: string;
298
+ /**
299
+ * Per-entity earning code mappings.
300
+ */
301
+ mappings?: Array<VariableCompensationPayoutTypeUpdateParams.Mapping>;
302
+ }
303
+ export declare namespace VariableCompensationPayoutTypeUpdateParams {
304
+ interface Mapping {
305
+ /**
306
+ * ID of the payroll entity this mapping applies to.
307
+ */
308
+ entity_id: string;
309
+ /**
310
+ * Mapping health status.
311
+ */
312
+ health: string;
313
+ /**
314
+ * Mapped earning code for the payroll entity.
315
+ */
316
+ earning_code?: string;
317
+ /**
318
+ * Display name of the mapped earning code at response time. Convenience snapshot
319
+ * for the mapping matrix; authoritative earning metadata lives in payroll, not
320
+ * this field.
321
+ */
322
+ earning_display_name?: string;
323
+ /**
324
+ * Display name of the payroll entity at response time. Convenience snapshot for
325
+ * the mapping matrix; authoritative entity data lives on payroll entities, not
326
+ * this field.
327
+ */
328
+ entity_name?: string;
329
+ }
330
+ }
331
+ export declare namespace VariableCompensationPayoutTypes {
332
+ export { type VariableCompensationPayoutTypeListResponse as VariableCompensationPayoutTypeListResponse, type VariableCompensationPayoutTypeCreateResponse as VariableCompensationPayoutTypeCreateResponse, type VariableCompensationPayoutTypeRetrieveResponse as VariableCompensationPayoutTypeRetrieveResponse, type VariableCompensationPayoutTypeUpdateResponse as VariableCompensationPayoutTypeUpdateResponse, type VariableCompensationPayoutTypeListResponsesPageCursorURL as VariableCompensationPayoutTypeListResponsesPageCursorURL, type VariableCompensationPayoutTypeCreateParams as VariableCompensationPayoutTypeCreateParams, type VariableCompensationPayoutTypeUpdateParams as VariableCompensationPayoutTypeUpdateParams, };
333
+ }
334
+ //# sourceMappingURL=variable-compensation-payout-types.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"variable-compensation-payout-types.d.mts","sourceRoot":"","sources":["../src/resources/variable-compensation-payout-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAEhE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,WAAW;IAC9D;;;;OAIG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CACZ,wDAAwD,EACxD,0CAA0C,CAC3C;IAQD;;;OAGG;IACH,MAAM,CACJ,IAAI,EAAE,0CAA0C,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4CAA4C,CAAC;IAI3D;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8CAA8C,CAAC;IAI1G;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,0CAA0C,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4CAA4C,CAAC;IAI3D;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,MAAM,wDAAwD,GAClE,aAAa,CAAC,0CAA0C,CAAC,CAAC;AAE5D,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,OAAO,CAAC,CAAC;CACtE;AAED,yBAAiB,0CAA0C,CAAC;IAC1D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,4CAA4C;IAC3D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,4CAA4C,CAAC,OAAO,CAAC,CAAC;CACxE;AAED,yBAAiB,4CAA4C,CAAC;IAC5D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,8CAA+C,SAAQ,mBAAmB,CAAC,IAAI;IAC9F;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,8CAA8C,CAAC,OAAO,CAAC,CAAC;CAC1E;AAED,yBAAiB,8CAA8C,CAAC;IAC9D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,4CAA4C;IAC3D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,4CAA4C,CAAC,OAAO,CAAC,CAAC;CACxE;AAED,yBAAiB,4CAA4C,CAAC;IAC5D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,OAAO,CAAC,CAAC;CACtE;AAED,yBAAiB,0CAA0C,CAAC;IAC1D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,OAAO,CAAC,CAAC;CACtE;AAED,yBAAiB,0CAA0C,CAAC;IAC1D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,+BAA+B,CAAC;IACvD,OAAO,EACL,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,4CAA4C,IAAI,4CAA4C,EACjG,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,4CAA4C,IAAI,4CAA4C,EACjG,KAAK,wDAAwD,IAAI,wDAAwD,EACzH,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,0CAA0C,IAAI,0CAA0C,GAC9F,CAAC;CACH"}