servicem8 0.3.16 → 0.3.17

package/dist/commonjs/funcs/formResponsesDeleteFormResponses.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 export declare function formResponsesDeleteFormResponses(client: ServiceM8Core, request: operations.DeleteFormResponsesRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteFormResponsesResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=formResponsesDeleteFormResponses.d.ts.map

package/dist/commonjs/funcs/formResponsesDeleteFormResponses.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 function formResponsesDeleteFormResponses(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/formsCreateForms.d.ts

@@ -14,7 +14,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function formsCreateForms(client: ServiceM8Core, request: components.FormInput, options?: RequestOptions): APIPromise<Result<operations.CreateFormsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=formsCreateForms.d.ts.map

package/dist/commonjs/funcs/formsCreateForms.js

@@ -53,7 +53,7 @@ const async_js_1 = require("../types/async.js");
  * @remarks
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function formsCreateForms(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/formsDeleteForms.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 export declare function formsDeleteForms(client: ServiceM8Core, request: operations.DeleteFormsRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteFormsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=formsDeleteForms.d.ts.map

package/dist/commonjs/funcs/formsDeleteForms.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 function formsDeleteForms(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobActivitiesCreateJobActivities.d.ts

@@ -17,7 +17,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **manage_schedule**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function jobActivitiesCreateJobActivities(client: ServiceM8Core, request: components.JobActivityInput, options?: RequestOptions): APIPromise<Result<operations.CreateJobActivitiesResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobActivitiesCreateJobActivities.d.ts.map

package/dist/commonjs/funcs/jobActivitiesCreateJobActivities.js

@@ -56,7 +56,7 @@ const async_js_1 = require("../types/async.js");
  * This endpoint requires the following OAuth scope **manage_schedule**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function jobActivitiesCreateJobActivities(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobActivitiesDeleteJobActivities.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_schedule**.

package/dist/commonjs/funcs/jobActivitiesDeleteJobActivities.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_schedule**.

package/dist/commonjs/funcs/jobAllocationsCreateJobAllocations.d.ts

@@ -17,7 +17,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **manage_schedule**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function jobAllocationsCreateJobAllocations(client: ServiceM8Core, request: components.JobAllocationInput, options?: RequestOptions): APIPromise<Result<operations.CreateJobAllocationsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobAllocationsCreateJobAllocations.d.ts.map

package/dist/commonjs/funcs/jobAllocationsCreateJobAllocations.js

@@ -56,7 +56,7 @@ const async_js_1 = require("../types/async.js");
  * This endpoint requires the following OAuth scope **manage_schedule**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function jobAllocationsCreateJobAllocations(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobAllocationsDeleteJobAllocations.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 export declare function jobAllocationsDeleteJobAllocations(client: ServiceM8Core, request: operations.DeleteJobAllocationsRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteJobAllocationsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobAllocationsDeleteJobAllocations.d.ts.map

package/dist/commonjs/funcs/jobAllocationsDeleteJobAllocations.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 function jobAllocationsDeleteJobAllocations(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobChecklistsCreateJobChecklists.d.ts

@@ -14,7 +14,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function jobChecklistsCreateJobChecklists(client: ServiceM8Core, request: components.JobChecklistInput, options?: RequestOptions): APIPromise<Result<operations.CreateJobChecklistsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobChecklistsCreateJobChecklists.d.ts.map

package/dist/commonjs/funcs/jobChecklistsCreateJobChecklists.js

@@ -53,7 +53,7 @@ const async_js_1 = require("../types/async.js");
  * @remarks
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function jobChecklistsCreateJobChecklists(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobChecklistsDeleteJobChecklists.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 export declare function jobChecklistsDeleteJobChecklists(client: ServiceM8Core, request: operations.DeleteJobChecklistsRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteJobChecklistsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobChecklistsDeleteJobChecklists.d.ts.map

package/dist/commonjs/funcs/jobChecklistsDeleteJobChecklists.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 function jobChecklistsDeleteJobChecklists(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobContactsCreateJobContacts.d.ts

@@ -17,7 +17,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **manage_job_contacts**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function jobContactsCreateJobContacts(client: ServiceM8Core, request: components.JobContactInput, options?: RequestOptions): APIPromise<Result<operations.CreateJobContactsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobContactsCreateJobContacts.d.ts.map

package/dist/commonjs/funcs/jobContactsCreateJobContacts.js

@@ -56,7 +56,7 @@ const async_js_1 = require("../types/async.js");
  * This endpoint requires the following OAuth scope **manage_job_contacts**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function jobContactsCreateJobContacts(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobContactsDeleteJobContacts.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_job_contacts**.

package/dist/commonjs/funcs/jobContactsDeleteJobContacts.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_job_contacts**.

package/dist/commonjs/funcs/jobMaterialBundlesCreateJobMaterialBundles.d.ts

@@ -14,7 +14,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function jobMaterialBundlesCreateJobMaterialBundles(client: ServiceM8Core, request: components.JobMaterialBundleInput, options?: RequestOptions): APIPromise<Result<operations.CreateJobMaterialBundlesResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobMaterialBundlesCreateJobMaterialBundles.d.ts.map

package/dist/commonjs/funcs/jobMaterialBundlesCreateJobMaterialBundles.js

@@ -53,7 +53,7 @@ const async_js_1 = require("../types/async.js");
  * @remarks
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function jobMaterialBundlesCreateJobMaterialBundles(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobMaterialBundlesDeleteJobMaterialBundles.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 export declare function jobMaterialBundlesDeleteJobMaterialBundles(client: ServiceM8Core, request: operations.DeleteJobMaterialBundlesRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteJobMaterialBundlesResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobMaterialBundlesDeleteJobMaterialBundles.d.ts.map

package/dist/commonjs/funcs/jobMaterialBundlesDeleteJobMaterialBundles.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 function jobMaterialBundlesDeleteJobMaterialBundles(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobMaterialsCreateJobMaterials.d.ts

@@ -17,7 +17,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **manage_job_materials**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function jobMaterialsCreateJobMaterials(client: ServiceM8Core, request: components.JobMaterialInput, options?: RequestOptions): APIPromise<Result<operations.CreateJobMaterialsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobMaterialsCreateJobMaterials.d.ts.map

package/dist/commonjs/funcs/jobMaterialsCreateJobMaterials.js

@@ -56,7 +56,7 @@ const async_js_1 = require("../types/async.js");
  * This endpoint requires the following OAuth scope **manage_job_materials**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function jobMaterialsCreateJobMaterials(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobMaterialsDeleteJobMaterials.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_job_materials**.

package/dist/commonjs/funcs/jobMaterialsDeleteJobMaterials.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_job_materials**.

package/dist/commonjs/funcs/jobPaymentsCreateJobPayments.d.ts

@@ -14,7 +14,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function jobPaymentsCreateJobPayments(client: ServiceM8Core, request: components.JobPaymentInput, options?: RequestOptions): APIPromise<Result<operations.CreateJobPaymentsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobPaymentsCreateJobPayments.d.ts.map

package/dist/commonjs/funcs/jobPaymentsCreateJobPayments.js

@@ -53,7 +53,7 @@ const async_js_1 = require("../types/async.js");
  * @remarks
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function jobPaymentsCreateJobPayments(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobPaymentsDeleteJobPayments.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 export declare function jobPaymentsDeleteJobPayments(client: ServiceM8Core, request: operations.DeleteJobPaymentsRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteJobPaymentsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobPaymentsDeleteJobPayments.d.ts.map

package/dist/commonjs/funcs/jobPaymentsDeleteJobPayments.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 function jobPaymentsDeleteJobPayments(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobQueuesCreateJobQueues.d.ts

@@ -17,7 +17,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **manage_job_queues**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function jobQueuesCreateJobQueues(client: ServiceM8Core, request: components.QueueInput, options?: RequestOptions): APIPromise<Result<operations.CreateJobQueuesResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobQueuesCreateJobQueues.d.ts.map

package/dist/commonjs/funcs/jobQueuesCreateJobQueues.js

@@ -56,7 +56,7 @@ const async_js_1 = require("../types/async.js");
  * This endpoint requires the following OAuth scope **manage_job_queues**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function jobQueuesCreateJobQueues(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobQueuesDeleteJobQueues.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_job_queues**.

package/dist/commonjs/funcs/jobQueuesDeleteJobQueues.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_job_queues**.

package/dist/commonjs/funcs/jobsCreateJobs.d.ts

@@ -17,7 +17,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **create_jobs**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function jobsCreateJobs(client: ServiceM8Core, request: components.JobInput, options?: RequestOptions): APIPromise<Result<operations.CreateJobsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=jobsCreateJobs.d.ts.map

package/dist/commonjs/funcs/jobsCreateJobs.js

@@ -56,7 +56,7 @@ const async_js_1 = require("../types/async.js");
  * This endpoint requires the following OAuth scope **create_jobs**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function jobsCreateJobs(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/jobsDeleteJobs.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_jobs**.

package/dist/commonjs/funcs/jobsDeleteJobs.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_jobs**.

package/dist/commonjs/funcs/knowledgeArticlesCreateKnowledgeArticles.d.ts

@@ -17,7 +17,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **manage_knowledge**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function knowledgeArticlesCreateKnowledgeArticles(client: ServiceM8Core, request: components.KnowledgeArticleInput, options?: RequestOptions): APIPromise<Result<operations.CreateKnowledgeArticlesResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=knowledgeArticlesCreateKnowledgeArticles.d.ts.map

package/dist/commonjs/funcs/knowledgeArticlesCreateKnowledgeArticles.js

@@ -56,7 +56,7 @@ const async_js_1 = require("../types/async.js");
  * This endpoint requires the following OAuth scope **manage_knowledge**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function knowledgeArticlesCreateKnowledgeArticles(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/knowledgeArticlesDeleteKnowledgeArticles.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 export declare function knowledgeArticlesDeleteKnowledgeArticles(client: ServiceM8Core, request: operations.DeleteKnowledgeArticlesRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteKnowledgeArticlesResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=knowledgeArticlesDeleteKnowledgeArticles.d.ts.map

package/dist/commonjs/funcs/knowledgeArticlesDeleteKnowledgeArticles.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  */
 function knowledgeArticlesDeleteKnowledgeArticles(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/locationsCreateLocations.d.ts

@@ -17,7 +17,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **manage_locations**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function locationsCreateLocations(client: ServiceM8Core, request: components.LocationInput, options?: RequestOptions): APIPromise<Result<operations.CreateLocationsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=locationsCreateLocations.d.ts.map

package/dist/commonjs/funcs/locationsCreateLocations.js

@@ -56,7 +56,7 @@ const async_js_1 = require("../types/async.js");
  * This endpoint requires the following OAuth scope **manage_locations**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function locationsCreateLocations(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/locationsDeleteLocations.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_locations**.

package/dist/commonjs/funcs/locationsDeleteLocations.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_locations**.

package/dist/commonjs/funcs/materialsCreateMaterials.d.ts

@@ -17,7 +17,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **manage_inventory**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 export declare function materialsCreateMaterials(client: ServiceM8Core, request: components.MaterialInput, options?: RequestOptions): APIPromise<Result<operations.CreateMaterialsResponse, errors.ErrorT | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=materialsCreateMaterials.d.ts.map

package/dist/commonjs/funcs/materialsCreateMaterials.js

@@ -56,7 +56,7 @@ const async_js_1 = require("../types/async.js");
  * This endpoint requires the following OAuth scope **manage_inventory**.
  *
  * #### Record UUID
- * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+ * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
  */
 function materialsCreateMaterials(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/materialsDeleteMaterials.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- * In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+ * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_inventory**.