@dsptch-work/api-client 0.15.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4004,6 +4004,57 @@ export class FringeBenefitPlans {
4004
4004
  });
4005
4005
  }
4006
4006
  }
4007
+ export class PaystubImports {
4008
+ /**
4009
+ * List Paystub Imports
4010
+ *
4011
+ * **Required scope:**
4012
+ *
4013
+ * `payrolls.payroll_runs.imports.paystubs:read`
4014
+ *
4015
+ */
4016
+ static listPaystubImports(options) {
4017
+ return (options.client ?? client).get({
4018
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
4019
+ url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs',
4020
+ ...options
4021
+ });
4022
+ }
4023
+ /**
4024
+ * Create Paystub Import
4025
+ *
4026
+ * **Required scope:**
4027
+ *
4028
+ * `payrolls.payroll_runs.imports.paystubs:create`
4029
+ *
4030
+ */
4031
+ static createPaystubImport(options) {
4032
+ return (options.client ?? client).post({
4033
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
4034
+ url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs',
4035
+ ...options,
4036
+ headers: {
4037
+ 'Content-Type': 'application/json',
4038
+ ...options.headers
4039
+ }
4040
+ });
4041
+ }
4042
+ /**
4043
+ * Get Paystub Import
4044
+ *
4045
+ * **Required scope:**
4046
+ *
4047
+ * `payrolls.payroll_runs.imports.paystubs:read`
4048
+ *
4049
+ */
4050
+ static getPaystubImport(options) {
4051
+ return (options.client ?? client).get({
4052
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
4053
+ url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs/{id}',
4054
+ ...options
4055
+ });
4056
+ }
4057
+ }
4007
4058
  export class PayrollRuns {
4008
4059
  /**
4009
4060
  * List payroll runs
@@ -5391,7 +5442,7 @@ export class TimeEntries {
5391
5442
  * Hard-delete a time entry by id (the record is removed) and return its final
5392
5443
  * serialized representation. Destruction runs the model's after_destroy
5393
5444
  * cascade — recomputing the time card's rollups, uncategorized allocations,
5394
- * PWA/actuals (when paystubs exist), and reassigning shifts. Returns 403 when
5445
+ * PWA/actuals (when paystubs exist), and reassigning shifts. Returns 404 when
5395
5446
  * the entry belongs to another company, and 422 (RecordNotDestroyed) when its
5396
5447
  * time card is locked.
5397
5448
  *
@@ -5412,9 +5463,10 @@ export class TimeEntries {
5412
5463
  * Update time entry
5413
5464
  *
5414
5465
  * Update an existing time entry by id; every field in the parameters is
5415
- * optional and only supplied fields change. Authorization is re-checked after
5416
- * attributes are assigned, so moving the entry to a time card in another
5417
- * company is forbidden (403). If the change would push categorized allocation
5466
+ * optional and only supplied fields change. An entry outside the key's scope
5467
+ * is not found (404). Authorization is re-checked after attributes are
5468
+ * assigned, so moving the entry to a time card in another company is
5469
+ * forbidden (403). If the change would push categorized allocation
5418
5470
  * minutes past the time card's overtime eligible minutes, the request returns
5419
5471
  * 422 unless confirm_allocation_conflict is sent true. The feature-allocation cap is
5420
5472
  * enforced, and because a persisted feature_ids= writes its join rows
@@ -6000,6 +6052,37 @@ export class TimeCardActuals {
6000
6052
  });
6001
6053
  }
6002
6054
  }
6055
+ export class Todos {
6056
+ /**
6057
+ * List Todos
6058
+ *
6059
+ * List your company's open work in one list: todos that are not yet completed, and failing
6060
+ * compliance checks on a requirement your company has highlighted. Entries come back
6061
+ * soonest-due first, with undated entries last.
6062
+ *
6063
+ * Read `kind` on an entry before anything else — a `todo` and a `compliance_check` are
6064
+ * different resources, with different fields and separate id spaces. Both also carry a
6065
+ * `type` field, scoped by `kind`: on a todo it's company, job, or project; on a compliance
6066
+ * check it's the check's class name, rendered exactly as it does at the Compliance Checks
6067
+ * endpoints, since it's the same resource. Write a check through those endpoints; this
6068
+ * list is read-only.
6069
+ *
6070
+ * The whole inbox is returned in one response; the list is not paginated.
6071
+ *
6072
+ *
6073
+ * **Required scope:**
6074
+ *
6075
+ * `todos:read`
6076
+ *
6077
+ */
6078
+ static listTodoInbox(options) {
6079
+ return (options?.client ?? client).get({
6080
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
6081
+ url: '/api/v1/todos',
6082
+ ...options
6083
+ });
6084
+ }
6085
+ }
6003
6086
  export class UserRoles {
6004
6087
  /**
6005
6088
  * List user roles
@@ -6055,6 +6138,8 @@ export class WageDeterminations {
6055
6138
  /**
6056
6139
  * List labor rates
6057
6140
  *
6141
+ * Company and user keys require the paid wage determinations entitlement on the acting company. Trusted application keys bypass this product gate.
6142
+ *
6058
6143
  * **Required scope:**
6059
6144
  *
6060
6145
  * `wage_determinations.labor_rates:read`
@@ -6070,6 +6155,8 @@ export class WageDeterminations {
6070
6155
  /**
6071
6156
  * List wage determinations
6072
6157
  *
6158
+ * Company and user keys require the paid wage determinations entitlement on the acting company. Trusted application keys bypass this product gate.
6159
+ *
6073
6160
  * **Required scope:**
6074
6161
  *
6075
6162
  * `wage_determinations:read`
@@ -6085,6 +6172,8 @@ export class WageDeterminations {
6085
6172
  /**
6086
6173
  * Show wage determination
6087
6174
  *
6175
+ * Company and user keys require the paid wage determinations entitlement on the acting company. Trusted application keys bypass this product gate.
6176
+ *
6088
6177
  * **Required scope:**
6089
6178
  *
6090
6179
  * `wage_determinations:read`