@workbuddy/cli-vnext 1.0.138 → 1.0.139
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +2024 -979
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -8852,40 +8852,32 @@ var operations = [
|
|
|
8852
8852
|
hasRequestBody: true
|
|
8853
8853
|
},
|
|
8854
8854
|
{
|
|
8855
|
-
operationId: "
|
|
8856
|
-
displayName: "List
|
|
8857
|
-
description: "
|
|
8855
|
+
operationId: "PublicJobStageAppointmentController_list",
|
|
8856
|
+
displayName: "List stage appointments",
|
|
8857
|
+
description: "List stage appointments",
|
|
8858
8858
|
method: "GET",
|
|
8859
|
-
path: "/
|
|
8860
|
-
commandPath: ["
|
|
8859
|
+
path: "/jobs/{jobId}/stages/{stageId}/appointments",
|
|
8860
|
+
commandPath: ["stages", "appointments", "list"],
|
|
8861
8861
|
options: [
|
|
8862
8862
|
{
|
|
8863
|
-
name: "
|
|
8864
|
-
cliName: "
|
|
8865
|
-
optionKey: "
|
|
8863
|
+
name: "jobId",
|
|
8864
|
+
cliName: "job-id",
|
|
8865
|
+
optionKey: "jobId",
|
|
8866
8866
|
source: "path",
|
|
8867
8867
|
type: "string",
|
|
8868
8868
|
required: true,
|
|
8869
|
-
description: "
|
|
8870
|
-
|
|
8871
|
-
}
|
|
8872
|
-
],
|
|
8873
|
-
hasRequestBody: false,
|
|
8874
|
-
responseFields: [
|
|
8869
|
+
description: "Job ID"
|
|
8870
|
+
},
|
|
8875
8871
|
{
|
|
8876
|
-
name: "
|
|
8877
|
-
|
|
8872
|
+
name: "stageId",
|
|
8873
|
+
cliName: "stage-id",
|
|
8874
|
+
optionKey: "stageId",
|
|
8875
|
+
source: "path",
|
|
8876
|
+
type: "string",
|
|
8877
|
+
required: true,
|
|
8878
|
+
description: "Stage ID"
|
|
8878
8879
|
}
|
|
8879
|
-
]
|
|
8880
|
-
},
|
|
8881
|
-
{
|
|
8882
|
-
operationId: "PublicApiJobStatusController_list",
|
|
8883
|
-
displayName: "List job statuses",
|
|
8884
|
-
description: "Retrieve all possible job statuses. These are system-defined status values that represent the aggregated state of a job based on its stages.",
|
|
8885
|
-
method: "GET",
|
|
8886
|
-
path: "/settings/job-statuses",
|
|
8887
|
-
commandPath: ["settings", "reference", "data", "job-statuses", "list"],
|
|
8888
|
-
options: [],
|
|
8880
|
+
],
|
|
8889
8881
|
hasRequestBody: false,
|
|
8890
8882
|
responseFields: [
|
|
8891
8883
|
{
|
|
@@ -8895,174 +8887,117 @@ var operations = [
|
|
|
8895
8887
|
]
|
|
8896
8888
|
},
|
|
8897
8889
|
{
|
|
8898
|
-
operationId: "
|
|
8899
|
-
displayName: "
|
|
8900
|
-
description: "
|
|
8901
|
-
method: "
|
|
8902
|
-
path: "/
|
|
8903
|
-
commandPath: ["
|
|
8904
|
-
options: [
|
|
8905
|
-
hasRequestBody: false,
|
|
8906
|
-
responseFields: [
|
|
8890
|
+
operationId: "PublicJobStageAppointmentController_create",
|
|
8891
|
+
displayName: "Create a stage appointment",
|
|
8892
|
+
description: "start and end are a local clock with no timezone, read in the stage site timezone. A status other than Open is applied after the appointment is created.",
|
|
8893
|
+
method: "POST",
|
|
8894
|
+
path: "/jobs/{jobId}/stages/{stageId}/appointments",
|
|
8895
|
+
commandPath: ["stages", "appointments", "create"],
|
|
8896
|
+
options: [
|
|
8907
8897
|
{
|
|
8908
|
-
name: "
|
|
8909
|
-
|
|
8910
|
-
|
|
8911
|
-
|
|
8912
|
-
|
|
8913
|
-
|
|
8914
|
-
|
|
8915
|
-
|
|
8916
|
-
description: "Retrieve all active, public job templates configured for the tenant. Use the returned id as the templateId for POST /jobs/template/:templateId.",
|
|
8917
|
-
method: "GET",
|
|
8918
|
-
path: "/settings/job-templates",
|
|
8919
|
-
commandPath: ["settings", "reference", "data", "job-templates", "list"],
|
|
8920
|
-
options: [],
|
|
8921
|
-
hasRequestBody: false,
|
|
8922
|
-
responseFields: [
|
|
8898
|
+
name: "jobId",
|
|
8899
|
+
cliName: "job-id",
|
|
8900
|
+
optionKey: "jobId",
|
|
8901
|
+
source: "path",
|
|
8902
|
+
type: "string",
|
|
8903
|
+
required: true,
|
|
8904
|
+
description: "Job ID"
|
|
8905
|
+
},
|
|
8923
8906
|
{
|
|
8924
|
-
name: "
|
|
8925
|
-
|
|
8926
|
-
|
|
8927
|
-
|
|
8928
|
-
|
|
8929
|
-
|
|
8930
|
-
|
|
8931
|
-
|
|
8932
|
-
description: "Retrieve all active priority levels configured for the tenant. Priorities indicate the urgency of jobs (e.g., Critical, High, Medium, Low).",
|
|
8933
|
-
method: "GET",
|
|
8934
|
-
path: "/settings/priorities",
|
|
8935
|
-
commandPath: ["settings", "reference", "data", "priorities", "list"],
|
|
8936
|
-
options: [],
|
|
8937
|
-
hasRequestBody: false,
|
|
8938
|
-
responseFields: [
|
|
8907
|
+
name: "stageId",
|
|
8908
|
+
cliName: "stage-id",
|
|
8909
|
+
optionKey: "stageId",
|
|
8910
|
+
source: "path",
|
|
8911
|
+
type: "string",
|
|
8912
|
+
required: true,
|
|
8913
|
+
description: "Stage ID"
|
|
8914
|
+
},
|
|
8939
8915
|
{
|
|
8940
|
-
name: "
|
|
8941
|
-
|
|
8942
|
-
|
|
8943
|
-
|
|
8944
|
-
|
|
8945
|
-
|
|
8946
|
-
|
|
8947
|
-
|
|
8948
|
-
description: "Discover tenant pricebooks for a category (customer / contractor / supplier). Use category=customer&status=current&assignableOnly=true for job-create candidates. Optional accountId scopes to a CRM account (includeGlobal defaults true). Each item includes company (owning company) and optional account — both match Settings UI fields.",
|
|
8949
|
-
method: "GET",
|
|
8950
|
-
path: "/settings/pricebooks",
|
|
8951
|
-
commandPath: ["settings", "reference", "data", "pricebooks", "list"],
|
|
8952
|
-
options: [
|
|
8916
|
+
name: "resourceId",
|
|
8917
|
+
cliName: "resource-id",
|
|
8918
|
+
optionKey: "resourceId",
|
|
8919
|
+
source: "body",
|
|
8920
|
+
type: "string",
|
|
8921
|
+
required: true,
|
|
8922
|
+
description: "resource ID"
|
|
8923
|
+
},
|
|
8953
8924
|
{
|
|
8954
|
-
name: "
|
|
8955
|
-
cliName: "
|
|
8956
|
-
optionKey: "
|
|
8957
|
-
source: "
|
|
8958
|
-
type: "
|
|
8959
|
-
required:
|
|
8925
|
+
name: "start",
|
|
8926
|
+
cliName: "start",
|
|
8927
|
+
optionKey: "start",
|
|
8928
|
+
source: "body",
|
|
8929
|
+
type: "string",
|
|
8930
|
+
required: true,
|
|
8960
8931
|
description: ""
|
|
8961
8932
|
},
|
|
8962
8933
|
{
|
|
8963
|
-
name: "
|
|
8964
|
-
cliName: "
|
|
8965
|
-
optionKey: "
|
|
8966
|
-
source: "
|
|
8967
|
-
type: "
|
|
8968
|
-
required:
|
|
8934
|
+
name: "end",
|
|
8935
|
+
cliName: "end",
|
|
8936
|
+
optionKey: "end",
|
|
8937
|
+
source: "body",
|
|
8938
|
+
type: "string",
|
|
8939
|
+
required: true,
|
|
8969
8940
|
description: ""
|
|
8970
8941
|
},
|
|
8971
8942
|
{
|
|
8972
|
-
name: "
|
|
8973
|
-
cliName: "
|
|
8974
|
-
optionKey: "
|
|
8975
|
-
source: "
|
|
8943
|
+
name: "type",
|
|
8944
|
+
cliName: "type",
|
|
8945
|
+
optionKey: "type",
|
|
8946
|
+
source: "body",
|
|
8976
8947
|
type: "string",
|
|
8977
8948
|
required: false,
|
|
8978
8949
|
description: "",
|
|
8979
|
-
enumValues: ["
|
|
8950
|
+
enumValues: ["Onsite", "Meeting", "Phone Call"]
|
|
8980
8951
|
},
|
|
8981
8952
|
{
|
|
8982
|
-
name: "
|
|
8983
|
-
cliName: "
|
|
8984
|
-
optionKey: "
|
|
8985
|
-
source: "
|
|
8953
|
+
name: "bookingStatus",
|
|
8954
|
+
cliName: "booking-status",
|
|
8955
|
+
optionKey: "bookingStatus",
|
|
8956
|
+
source: "body",
|
|
8986
8957
|
type: "string",
|
|
8987
8958
|
required: false,
|
|
8988
|
-
description: "
|
|
8959
|
+
description: "",
|
|
8960
|
+
enumValues: ["Confirmed", "Tentative"]
|
|
8989
8961
|
},
|
|
8990
8962
|
{
|
|
8991
|
-
name: "
|
|
8992
|
-
cliName: "
|
|
8993
|
-
optionKey: "
|
|
8994
|
-
source: "
|
|
8995
|
-
type: "
|
|
8963
|
+
name: "note",
|
|
8964
|
+
cliName: "note",
|
|
8965
|
+
optionKey: "note",
|
|
8966
|
+
source: "body",
|
|
8967
|
+
type: "string",
|
|
8996
8968
|
required: false,
|
|
8997
8969
|
description: ""
|
|
8998
8970
|
},
|
|
8999
8971
|
{
|
|
9000
|
-
name: "
|
|
9001
|
-
cliName: "
|
|
9002
|
-
optionKey: "
|
|
9003
|
-
source: "
|
|
8972
|
+
name: "integrationId",
|
|
8973
|
+
cliName: "integration-id",
|
|
8974
|
+
optionKey: "integrationId",
|
|
8975
|
+
source: "body",
|
|
9004
8976
|
type: "string",
|
|
9005
8977
|
required: false,
|
|
9006
|
-
description: "
|
|
8978
|
+
description: "integration ID"
|
|
9007
8979
|
},
|
|
9008
8980
|
{
|
|
9009
8981
|
name: "status",
|
|
9010
8982
|
cliName: "status",
|
|
9011
8983
|
optionKey: "status",
|
|
9012
|
-
source: "
|
|
8984
|
+
source: "body",
|
|
9013
8985
|
type: "string",
|
|
9014
8986
|
required: false,
|
|
9015
|
-
description: "",
|
|
9016
|
-
enumValues: ["
|
|
9017
|
-
},
|
|
9018
|
-
{
|
|
9019
|
-
name: "category",
|
|
9020
|
-
cliName: "category",
|
|
9021
|
-
optionKey: "category",
|
|
9022
|
-
source: "query",
|
|
9023
|
-
type: "string",
|
|
9024
|
-
required: true,
|
|
9025
|
-
description: "",
|
|
9026
|
-
enumValues: ["customer", "contractor", "supplier"]
|
|
9027
|
-
}
|
|
9028
|
-
],
|
|
9029
|
-
hasRequestBody: false,
|
|
9030
|
-
responseFields: [
|
|
9031
|
-
{
|
|
9032
|
-
name: "items",
|
|
9033
|
-
type: "array"
|
|
9034
|
-
}
|
|
9035
|
-
]
|
|
9036
|
-
},
|
|
9037
|
-
{
|
|
9038
|
-
operationId: "PublicApiPriceBookController_getByIdOrName",
|
|
9039
|
-
displayName: "Get pricebook",
|
|
9040
|
-
description: "Retrieve a pricebook by id (preferred) or exact name (case-insensitive). Pass category when the name may exist in more than one category. Response includes company (owning company) and optional account, matching Settings UI.",
|
|
9041
|
-
method: "GET",
|
|
9042
|
-
path: "/settings/pricebooks/{idOrName}",
|
|
9043
|
-
commandPath: ["settings", "reference", "data", "pricebooks", "get"],
|
|
9044
|
-
options: [
|
|
9045
|
-
{
|
|
9046
|
-
name: "idOrName",
|
|
9047
|
-
cliName: "id-or-name",
|
|
9048
|
-
optionKey: "idOrName",
|
|
9049
|
-
source: "path",
|
|
9050
|
-
type: "string",
|
|
9051
|
-
required: true,
|
|
9052
|
-
description: "Pricebook id or exact name"
|
|
8987
|
+
description: "Status filter",
|
|
8988
|
+
enumValues: ["Open", "Enroute", "Onsite", "Checked Out", "Completed", "Cancelled"]
|
|
9053
8989
|
},
|
|
9054
8990
|
{
|
|
9055
|
-
name: "
|
|
9056
|
-
cliName: "
|
|
9057
|
-
optionKey: "
|
|
9058
|
-
source: "
|
|
9059
|
-
type: "
|
|
8991
|
+
name: "raw-body",
|
|
8992
|
+
cliName: "raw-body",
|
|
8993
|
+
optionKey: "rawBody",
|
|
8994
|
+
source: "body",
|
|
8995
|
+
type: "object",
|
|
9060
8996
|
required: false,
|
|
9061
|
-
description: ""
|
|
9062
|
-
enumValues: ["customer", "contractor", "supplier"]
|
|
8997
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
9063
8998
|
}
|
|
9064
8999
|
],
|
|
9065
|
-
hasRequestBody:
|
|
9000
|
+
hasRequestBody: true,
|
|
9066
9001
|
responseFields: [
|
|
9067
9002
|
{
|
|
9068
9003
|
name: "id",
|
|
@@ -9070,76 +9005,191 @@ var operations = [
|
|
|
9070
9005
|
description: "Entity ID"
|
|
9071
9006
|
},
|
|
9072
9007
|
{
|
|
9073
|
-
name: "
|
|
9074
|
-
type: "string",
|
|
9075
|
-
description: "Display name"
|
|
9076
|
-
},
|
|
9077
|
-
{
|
|
9078
|
-
name: "description",
|
|
9079
|
-
type: "string",
|
|
9080
|
-
description: "Detailed description"
|
|
9081
|
-
},
|
|
9082
|
-
{
|
|
9083
|
-
name: "category",
|
|
9008
|
+
name: "resource",
|
|
9084
9009
|
type: "string"
|
|
9085
9010
|
},
|
|
9086
9011
|
{
|
|
9087
|
-
name: "
|
|
9088
|
-
type: "string"
|
|
9089
|
-
description: "Search mode"
|
|
9012
|
+
name: "start",
|
|
9013
|
+
type: "string"
|
|
9090
9014
|
},
|
|
9091
9015
|
{
|
|
9092
|
-
name: "
|
|
9093
|
-
type: "string"
|
|
9094
|
-
description: "Status filter"
|
|
9016
|
+
name: "end",
|
|
9017
|
+
type: "string"
|
|
9095
9018
|
},
|
|
9096
9019
|
{
|
|
9097
|
-
name: "
|
|
9098
|
-
type: "
|
|
9020
|
+
name: "timezone",
|
|
9021
|
+
type: "string"
|
|
9099
9022
|
},
|
|
9100
9023
|
{
|
|
9101
|
-
name: "
|
|
9102
|
-
type: "
|
|
9024
|
+
name: "type",
|
|
9025
|
+
type: "string"
|
|
9103
9026
|
},
|
|
9104
9027
|
{
|
|
9105
|
-
name: "
|
|
9028
|
+
name: "bookingStatus",
|
|
9106
9029
|
type: "string"
|
|
9107
9030
|
},
|
|
9108
9031
|
{
|
|
9109
|
-
name: "
|
|
9032
|
+
name: "note",
|
|
9110
9033
|
type: "string"
|
|
9111
9034
|
},
|
|
9112
9035
|
{
|
|
9113
|
-
name: "
|
|
9036
|
+
name: "status",
|
|
9037
|
+
type: "string",
|
|
9038
|
+
description: "Status filter"
|
|
9039
|
+
},
|
|
9040
|
+
{
|
|
9041
|
+
name: "integrationId",
|
|
9042
|
+
type: "string",
|
|
9043
|
+
description: "integration ID"
|
|
9044
|
+
}
|
|
9045
|
+
]
|
|
9046
|
+
},
|
|
9047
|
+
{
|
|
9048
|
+
operationId: "PublicJobStageAppointmentController_update",
|
|
9049
|
+
displayName: "Update an appointment status or booking",
|
|
9050
|
+
description: "Update an appointment status or booking",
|
|
9051
|
+
method: "PATCH",
|
|
9052
|
+
path: "/jobs/{jobId}/stages/{stageId}/appointments/{appointmentId}",
|
|
9053
|
+
commandPath: ["stages", "appointments", "update"],
|
|
9054
|
+
options: [
|
|
9055
|
+
{
|
|
9056
|
+
name: "jobId",
|
|
9057
|
+
cliName: "job-id",
|
|
9058
|
+
optionKey: "jobId",
|
|
9059
|
+
source: "path",
|
|
9060
|
+
type: "string",
|
|
9061
|
+
required: true,
|
|
9062
|
+
description: "Job ID"
|
|
9063
|
+
},
|
|
9064
|
+
{
|
|
9065
|
+
name: "stageId",
|
|
9066
|
+
cliName: "stage-id",
|
|
9067
|
+
optionKey: "stageId",
|
|
9068
|
+
source: "path",
|
|
9069
|
+
type: "string",
|
|
9070
|
+
required: true,
|
|
9071
|
+
description: "Stage ID"
|
|
9072
|
+
},
|
|
9073
|
+
{
|
|
9074
|
+
name: "appointmentId",
|
|
9075
|
+
cliName: "appointment-id",
|
|
9076
|
+
optionKey: "appointmentId",
|
|
9077
|
+
source: "path",
|
|
9078
|
+
type: "string",
|
|
9079
|
+
required: true,
|
|
9080
|
+
description: "Appointment ID"
|
|
9081
|
+
},
|
|
9082
|
+
{
|
|
9083
|
+
name: "status",
|
|
9084
|
+
cliName: "status",
|
|
9085
|
+
optionKey: "status",
|
|
9086
|
+
source: "body",
|
|
9087
|
+
type: "string",
|
|
9088
|
+
required: false,
|
|
9089
|
+
description: "Status filter",
|
|
9090
|
+
enumValues: ["Open", "Enroute", "Onsite", "Checked Out", "Completed", "Cancelled"]
|
|
9091
|
+
},
|
|
9092
|
+
{
|
|
9093
|
+
name: "bookingStatus",
|
|
9094
|
+
cliName: "booking-status",
|
|
9095
|
+
optionKey: "bookingStatus",
|
|
9096
|
+
source: "body",
|
|
9097
|
+
type: "string",
|
|
9098
|
+
required: false,
|
|
9099
|
+
description: "",
|
|
9100
|
+
enumValues: ["Confirmed", "Tentative"]
|
|
9101
|
+
},
|
|
9102
|
+
{
|
|
9103
|
+
name: "raw-body",
|
|
9104
|
+
cliName: "raw-body",
|
|
9105
|
+
optionKey: "rawBody",
|
|
9106
|
+
source: "body",
|
|
9107
|
+
type: "object",
|
|
9108
|
+
required: false,
|
|
9109
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
9110
|
+
}
|
|
9111
|
+
],
|
|
9112
|
+
hasRequestBody: true,
|
|
9113
|
+
responseFields: [
|
|
9114
|
+
{
|
|
9115
|
+
name: "id",
|
|
9116
|
+
type: "string",
|
|
9117
|
+
description: "Entity ID"
|
|
9118
|
+
},
|
|
9119
|
+
{
|
|
9120
|
+
name: "resource",
|
|
9114
9121
|
type: "string"
|
|
9115
9122
|
},
|
|
9116
9123
|
{
|
|
9117
|
-
name: "
|
|
9124
|
+
name: "start",
|
|
9125
|
+
type: "string"
|
|
9126
|
+
},
|
|
9127
|
+
{
|
|
9128
|
+
name: "end",
|
|
9129
|
+
type: "string"
|
|
9130
|
+
},
|
|
9131
|
+
{
|
|
9132
|
+
name: "timezone",
|
|
9133
|
+
type: "string"
|
|
9134
|
+
},
|
|
9135
|
+
{
|
|
9136
|
+
name: "type",
|
|
9137
|
+
type: "string"
|
|
9138
|
+
},
|
|
9139
|
+
{
|
|
9140
|
+
name: "bookingStatus",
|
|
9141
|
+
type: "string"
|
|
9142
|
+
},
|
|
9143
|
+
{
|
|
9144
|
+
name: "note",
|
|
9118
9145
|
type: "string"
|
|
9146
|
+
},
|
|
9147
|
+
{
|
|
9148
|
+
name: "status",
|
|
9149
|
+
type: "string",
|
|
9150
|
+
description: "Status filter"
|
|
9151
|
+
},
|
|
9152
|
+
{
|
|
9153
|
+
name: "integrationId",
|
|
9154
|
+
type: "string",
|
|
9155
|
+
description: "integration ID"
|
|
9119
9156
|
}
|
|
9120
9157
|
]
|
|
9121
9158
|
},
|
|
9122
9159
|
{
|
|
9123
|
-
operationId: "
|
|
9124
|
-
displayName: "List
|
|
9125
|
-
description:
|
|
9126
|
-
Each item is a workflow state a stage (work order) can use (e.g. New, Dispatched, En Route, On Site, Completed, Finalised).
|
|
9127
|
-
|
|
9128
|
-
Response fields include:
|
|
9129
|
-
- identity: id, name, systemName, systemStatus, sortOrder
|
|
9130
|
-
- description (nullable)
|
|
9131
|
-
- activityOptions: shareWithCustomer, shareWithField (always present; unset = false)
|
|
9132
|
-
- displayOptions: showInContractorPortal, showInFieldApp (always present)
|
|
9133
|
-
|
|
9134
|
-
Display Options rules (match Settings UI):
|
|
9135
|
-
- Only systemStatus On Hold or In Progress support display options; other systemStatus values return both flags as false
|
|
9136
|
-
- showInFieldApp is not configurable for In Progress and is always false
|
|
9137
|
-
- When supported and not configured, visibility defaults to true (Settings UI default)
|
|
9138
|
-
|
|
9139
|
-
Requires scope: settings:read`,
|
|
9160
|
+
operationId: "PublicApiEntityStatusController_list",
|
|
9161
|
+
displayName: "List entity statuses",
|
|
9162
|
+
description: "Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user, pending-item",
|
|
9140
9163
|
method: "GET",
|
|
9141
|
-
path: "/settings/
|
|
9142
|
-
commandPath: ["settings", "reference", "data", "
|
|
9164
|
+
path: "/settings/entity-statuses/{entity}",
|
|
9165
|
+
commandPath: ["settings", "reference", "data", "entity-statuses", "get"],
|
|
9166
|
+
options: [
|
|
9167
|
+
{
|
|
9168
|
+
name: "entity",
|
|
9169
|
+
cliName: "entity",
|
|
9170
|
+
optionKey: "entity",
|
|
9171
|
+
source: "path",
|
|
9172
|
+
type: "string",
|
|
9173
|
+
required: true,
|
|
9174
|
+
description: "Entity type (customer, contractor, supplier, contact, external-user, pending-item)",
|
|
9175
|
+
enumValues: ["customer", "contractor", "supplier", "contact", "external-user", "pending-item"]
|
|
9176
|
+
}
|
|
9177
|
+
],
|
|
9178
|
+
hasRequestBody: false,
|
|
9179
|
+
responseFields: [
|
|
9180
|
+
{
|
|
9181
|
+
name: "items",
|
|
9182
|
+
type: "array"
|
|
9183
|
+
}
|
|
9184
|
+
]
|
|
9185
|
+
},
|
|
9186
|
+
{
|
|
9187
|
+
operationId: "PublicApiJobStatusController_list",
|
|
9188
|
+
displayName: "List job statuses",
|
|
9189
|
+
description: "Retrieve all possible job statuses. These are system-defined status values that represent the aggregated state of a job based on its stages.",
|
|
9190
|
+
method: "GET",
|
|
9191
|
+
path: "/settings/job-statuses",
|
|
9192
|
+
commandPath: ["settings", "reference", "data", "job-statuses", "list"],
|
|
9143
9193
|
options: [],
|
|
9144
9194
|
hasRequestBody: false,
|
|
9145
9195
|
responseFields: [
|
|
@@ -9150,78 +9200,333 @@ Requires scope: settings:read`,
|
|
|
9150
9200
|
]
|
|
9151
9201
|
},
|
|
9152
9202
|
{
|
|
9153
|
-
operationId: "
|
|
9154
|
-
displayName: "List
|
|
9155
|
-
description: "Retrieve all active
|
|
9203
|
+
operationId: "PublicApiJobTypeController_list",
|
|
9204
|
+
displayName: "List job types",
|
|
9205
|
+
description: "Retrieve all active job types configured for the tenant. Job types categorize jobs by the type of work being performed (e.g., Maintenance, Installation, Repair).",
|
|
9156
9206
|
method: "GET",
|
|
9157
|
-
path: "/settings/
|
|
9158
|
-
commandPath: ["settings", "reference", "data", "
|
|
9207
|
+
path: "/settings/job-types",
|
|
9208
|
+
commandPath: ["settings", "reference", "data", "job-types", "list"],
|
|
9159
9209
|
options: [],
|
|
9160
9210
|
hasRequestBody: false,
|
|
9161
9211
|
responseFields: [
|
|
9162
9212
|
{
|
|
9163
9213
|
name: "items",
|
|
9164
9214
|
type: "array"
|
|
9165
|
-
}
|
|
9215
|
+
}
|
|
9216
|
+
]
|
|
9217
|
+
},
|
|
9218
|
+
{
|
|
9219
|
+
operationId: "PublicApiJobTemplateController_list",
|
|
9220
|
+
displayName: "List job templates",
|
|
9221
|
+
description: "Retrieve all active, public job templates configured for the tenant. Use the returned id as the templateId for POST /jobs/template/:templateId.",
|
|
9222
|
+
method: "GET",
|
|
9223
|
+
path: "/settings/job-templates",
|
|
9224
|
+
commandPath: ["settings", "reference", "data", "job-templates", "list"],
|
|
9225
|
+
options: [],
|
|
9226
|
+
hasRequestBody: false,
|
|
9227
|
+
responseFields: [
|
|
9166
9228
|
{
|
|
9167
|
-
name: "
|
|
9229
|
+
name: "items",
|
|
9168
9230
|
type: "array"
|
|
9169
|
-
}
|
|
9231
|
+
}
|
|
9232
|
+
]
|
|
9233
|
+
},
|
|
9234
|
+
{
|
|
9235
|
+
operationId: "PublicApiPriorityController_list",
|
|
9236
|
+
displayName: "List priorities",
|
|
9237
|
+
description: "Retrieve all active priority levels configured for the tenant. Priorities indicate the urgency of jobs (e.g., Critical, High, Medium, Low).",
|
|
9238
|
+
method: "GET",
|
|
9239
|
+
path: "/settings/priorities",
|
|
9240
|
+
commandPath: ["settings", "reference", "data", "priorities", "list"],
|
|
9241
|
+
options: [],
|
|
9242
|
+
hasRequestBody: false,
|
|
9243
|
+
responseFields: [
|
|
9170
9244
|
{
|
|
9171
|
-
name: "
|
|
9245
|
+
name: "items",
|
|
9172
9246
|
type: "array"
|
|
9173
9247
|
}
|
|
9174
9248
|
]
|
|
9175
9249
|
},
|
|
9176
9250
|
{
|
|
9177
|
-
operationId: "
|
|
9178
|
-
displayName: "
|
|
9179
|
-
description: "
|
|
9180
|
-
method: "
|
|
9181
|
-
path: "/settings/
|
|
9182
|
-
commandPath: ["settings", "reference", "data", "
|
|
9251
|
+
operationId: "PublicApiPriceBookController_list",
|
|
9252
|
+
displayName: "List pricebooks",
|
|
9253
|
+
description: "Discover tenant pricebooks for a category (customer / contractor / supplier). Use category=customer&status=current&assignableOnly=true for job-create candidates. Optional accountId scopes to a CRM account (includeGlobal defaults true). Each item includes company (owning company) and optional account — both match Settings UI fields.",
|
|
9254
|
+
method: "GET",
|
|
9255
|
+
path: "/settings/pricebooks",
|
|
9256
|
+
commandPath: ["settings", "reference", "data", "pricebooks", "list"],
|
|
9183
9257
|
options: [
|
|
9184
9258
|
{
|
|
9185
|
-
name: "
|
|
9186
|
-
cliName: "
|
|
9187
|
-
optionKey: "
|
|
9188
|
-
source: "
|
|
9189
|
-
type: "
|
|
9190
|
-
required:
|
|
9191
|
-
description: ""
|
|
9192
|
-
enumValues: ["service-type", "service-scope", "work-categories"]
|
|
9259
|
+
name: "limit",
|
|
9260
|
+
cliName: "limit",
|
|
9261
|
+
optionKey: "limit",
|
|
9262
|
+
source: "query",
|
|
9263
|
+
type: "number",
|
|
9264
|
+
required: false,
|
|
9265
|
+
description: ""
|
|
9193
9266
|
},
|
|
9194
9267
|
{
|
|
9195
|
-
name: "
|
|
9196
|
-
cliName: "
|
|
9197
|
-
optionKey: "
|
|
9198
|
-
source: "
|
|
9199
|
-
type: "
|
|
9200
|
-
required:
|
|
9201
|
-
description: "
|
|
9268
|
+
name: "assignableOnly",
|
|
9269
|
+
cliName: "assignable-only",
|
|
9270
|
+
optionKey: "assignableOnly",
|
|
9271
|
+
source: "query",
|
|
9272
|
+
type: "boolean",
|
|
9273
|
+
required: false,
|
|
9274
|
+
description: ""
|
|
9202
9275
|
},
|
|
9203
9276
|
{
|
|
9204
|
-
name: "
|
|
9205
|
-
cliName: "
|
|
9206
|
-
optionKey: "
|
|
9207
|
-
source: "
|
|
9277
|
+
name: "mode",
|
|
9278
|
+
cliName: "mode",
|
|
9279
|
+
optionKey: "mode",
|
|
9280
|
+
source: "query",
|
|
9208
9281
|
type: "string",
|
|
9209
9282
|
required: false,
|
|
9210
9283
|
description: "",
|
|
9211
|
-
enumValues: [
|
|
9212
|
-
|
|
9213
|
-
|
|
9214
|
-
|
|
9215
|
-
|
|
9216
|
-
|
|
9217
|
-
|
|
9218
|
-
|
|
9219
|
-
|
|
9220
|
-
|
|
9221
|
-
|
|
9222
|
-
|
|
9223
|
-
|
|
9224
|
-
|
|
9284
|
+
enumValues: ["static", "dynamic"]
|
|
9285
|
+
},
|
|
9286
|
+
{
|
|
9287
|
+
name: "search",
|
|
9288
|
+
cliName: "search",
|
|
9289
|
+
optionKey: "search",
|
|
9290
|
+
source: "query",
|
|
9291
|
+
type: "string",
|
|
9292
|
+
required: false,
|
|
9293
|
+
description: "Name contains or exact id"
|
|
9294
|
+
},
|
|
9295
|
+
{
|
|
9296
|
+
name: "includeGlobal",
|
|
9297
|
+
cliName: "include-global",
|
|
9298
|
+
optionKey: "includeGlobal",
|
|
9299
|
+
source: "query",
|
|
9300
|
+
type: "boolean",
|
|
9301
|
+
required: false,
|
|
9302
|
+
description: ""
|
|
9303
|
+
},
|
|
9304
|
+
{
|
|
9305
|
+
name: "accountId",
|
|
9306
|
+
cliName: "account-id",
|
|
9307
|
+
optionKey: "accountId",
|
|
9308
|
+
source: "query",
|
|
9309
|
+
type: "string",
|
|
9310
|
+
required: false,
|
|
9311
|
+
description: "account ID"
|
|
9312
|
+
},
|
|
9313
|
+
{
|
|
9314
|
+
name: "status",
|
|
9315
|
+
cliName: "status",
|
|
9316
|
+
optionKey: "status",
|
|
9317
|
+
source: "query",
|
|
9318
|
+
type: "string",
|
|
9319
|
+
required: false,
|
|
9320
|
+
description: "",
|
|
9321
|
+
enumValues: ["current", "expired", "future", "all"]
|
|
9322
|
+
},
|
|
9323
|
+
{
|
|
9324
|
+
name: "category",
|
|
9325
|
+
cliName: "category",
|
|
9326
|
+
optionKey: "category",
|
|
9327
|
+
source: "query",
|
|
9328
|
+
type: "string",
|
|
9329
|
+
required: true,
|
|
9330
|
+
description: "",
|
|
9331
|
+
enumValues: ["customer", "contractor", "supplier"]
|
|
9332
|
+
}
|
|
9333
|
+
],
|
|
9334
|
+
hasRequestBody: false,
|
|
9335
|
+
responseFields: [
|
|
9336
|
+
{
|
|
9337
|
+
name: "items",
|
|
9338
|
+
type: "array"
|
|
9339
|
+
}
|
|
9340
|
+
]
|
|
9341
|
+
},
|
|
9342
|
+
{
|
|
9343
|
+
operationId: "PublicApiPriceBookController_getByIdOrName",
|
|
9344
|
+
displayName: "Get pricebook",
|
|
9345
|
+
description: "Retrieve a pricebook by id (preferred) or exact name (case-insensitive). Pass category when the name may exist in more than one category. Response includes company (owning company) and optional account, matching Settings UI.",
|
|
9346
|
+
method: "GET",
|
|
9347
|
+
path: "/settings/pricebooks/{idOrName}",
|
|
9348
|
+
commandPath: ["settings", "reference", "data", "pricebooks", "get"],
|
|
9349
|
+
options: [
|
|
9350
|
+
{
|
|
9351
|
+
name: "idOrName",
|
|
9352
|
+
cliName: "id-or-name",
|
|
9353
|
+
optionKey: "idOrName",
|
|
9354
|
+
source: "path",
|
|
9355
|
+
type: "string",
|
|
9356
|
+
required: true,
|
|
9357
|
+
description: "Pricebook id or exact name"
|
|
9358
|
+
},
|
|
9359
|
+
{
|
|
9360
|
+
name: "category",
|
|
9361
|
+
cliName: "category",
|
|
9362
|
+
optionKey: "category",
|
|
9363
|
+
source: "query",
|
|
9364
|
+
type: "string",
|
|
9365
|
+
required: false,
|
|
9366
|
+
description: "",
|
|
9367
|
+
enumValues: ["customer", "contractor", "supplier"]
|
|
9368
|
+
}
|
|
9369
|
+
],
|
|
9370
|
+
hasRequestBody: false,
|
|
9371
|
+
responseFields: [
|
|
9372
|
+
{
|
|
9373
|
+
name: "id",
|
|
9374
|
+
type: "string",
|
|
9375
|
+
description: "Entity ID"
|
|
9376
|
+
},
|
|
9377
|
+
{
|
|
9378
|
+
name: "name",
|
|
9379
|
+
type: "string",
|
|
9380
|
+
description: "Display name"
|
|
9381
|
+
},
|
|
9382
|
+
{
|
|
9383
|
+
name: "description",
|
|
9384
|
+
type: "string",
|
|
9385
|
+
description: "Detailed description"
|
|
9386
|
+
},
|
|
9387
|
+
{
|
|
9388
|
+
name: "category",
|
|
9389
|
+
type: "string"
|
|
9390
|
+
},
|
|
9391
|
+
{
|
|
9392
|
+
name: "mode",
|
|
9393
|
+
type: "string",
|
|
9394
|
+
description: "Search mode"
|
|
9395
|
+
},
|
|
9396
|
+
{
|
|
9397
|
+
name: "status",
|
|
9398
|
+
type: "string",
|
|
9399
|
+
description: "Status filter"
|
|
9400
|
+
},
|
|
9401
|
+
{
|
|
9402
|
+
name: "parentOnly",
|
|
9403
|
+
type: "boolean"
|
|
9404
|
+
},
|
|
9405
|
+
{
|
|
9406
|
+
name: "isGlobal",
|
|
9407
|
+
type: "boolean"
|
|
9408
|
+
},
|
|
9409
|
+
{
|
|
9410
|
+
name: "account",
|
|
9411
|
+
type: "string"
|
|
9412
|
+
},
|
|
9413
|
+
{
|
|
9414
|
+
name: "company",
|
|
9415
|
+
type: "string"
|
|
9416
|
+
},
|
|
9417
|
+
{
|
|
9418
|
+
name: "dateStart",
|
|
9419
|
+
type: "string"
|
|
9420
|
+
},
|
|
9421
|
+
{
|
|
9422
|
+
name: "dateEnd",
|
|
9423
|
+
type: "string"
|
|
9424
|
+
}
|
|
9425
|
+
]
|
|
9426
|
+
},
|
|
9427
|
+
{
|
|
9428
|
+
operationId: "PublicApiStageStatusController_list",
|
|
9429
|
+
displayName: "List stage statuses",
|
|
9430
|
+
description: `Retrieve active stage statuses configured for the tenant (Settings > Stage Status). Soft-deleted statuses are omitted.
|
|
9431
|
+
Each item is a workflow state a stage (work order) can use (e.g. New, Dispatched, En Route, On Site, Completed, Finalised).
|
|
9432
|
+
|
|
9433
|
+
Response fields include:
|
|
9434
|
+
- identity: id, name, systemName, systemStatus, sortOrder
|
|
9435
|
+
- description (nullable)
|
|
9436
|
+
- activityOptions: shareWithCustomer, shareWithField (always present; unset = false)
|
|
9437
|
+
- displayOptions: showInContractorPortal, showInFieldApp (always present)
|
|
9438
|
+
|
|
9439
|
+
Display Options rules (match Settings UI):
|
|
9440
|
+
- Only systemStatus On Hold or In Progress support display options; other systemStatus values return both flags as false
|
|
9441
|
+
- showInFieldApp is not configurable for In Progress and is always false
|
|
9442
|
+
- When supported and not configured, visibility defaults to true (Settings UI default)
|
|
9443
|
+
|
|
9444
|
+
Requires scope: settings:read`,
|
|
9445
|
+
method: "GET",
|
|
9446
|
+
path: "/settings/stage-statuses",
|
|
9447
|
+
commandPath: ["settings", "reference", "data", "stage-statuses", "list"],
|
|
9448
|
+
options: [],
|
|
9449
|
+
hasRequestBody: false,
|
|
9450
|
+
responseFields: [
|
|
9451
|
+
{
|
|
9452
|
+
name: "items",
|
|
9453
|
+
type: "array"
|
|
9454
|
+
}
|
|
9455
|
+
]
|
|
9456
|
+
},
|
|
9457
|
+
{
|
|
9458
|
+
operationId: "PublicApiTagController_list",
|
|
9459
|
+
displayName: "List tags",
|
|
9460
|
+
description: "Retrieve all active tags (labels) configured. Use the optional `type` query parameter to filter by label type. Defaults to `job` if not specified. `colors` is the Settings label-picker palette used by PUT /settings/tags for non-service-type tags. `icons` is the Settings icon-picker names used by PUT /settings/tags for service-type. Supported types: job, scheduling, quote, customer, user, overheads, form, finance, system, work-order-system, account, contact, zone, work-categories, lead-source, lead, opportunity, opportunity-lost, project, project-type, payment-type, file, asset, item-location, task, phase, site, service-type, service-scope, subscriptions, agreement, work, integration-types, flag-category.",
|
|
9461
|
+
method: "GET",
|
|
9462
|
+
path: "/settings/tags",
|
|
9463
|
+
commandPath: ["settings", "reference", "data", "tags", "list"],
|
|
9464
|
+
options: [],
|
|
9465
|
+
hasRequestBody: false,
|
|
9466
|
+
responseFields: [
|
|
9467
|
+
{
|
|
9468
|
+
name: "items",
|
|
9469
|
+
type: "array"
|
|
9470
|
+
},
|
|
9471
|
+
{
|
|
9472
|
+
name: "colors",
|
|
9473
|
+
type: "array"
|
|
9474
|
+
},
|
|
9475
|
+
{
|
|
9476
|
+
name: "icons",
|
|
9477
|
+
type: "array"
|
|
9478
|
+
}
|
|
9479
|
+
]
|
|
9480
|
+
},
|
|
9481
|
+
{
|
|
9482
|
+
operationId: "PublicApiTagController_upsert",
|
|
9483
|
+
displayName: "Upsert a tag",
|
|
9484
|
+
description: "Create a tag, or return the existing active tag with the same type and name (case-insensitive). Limited to service-type, service-scope, and work-categories. service-type uses icon (Settings icon-picker name; omitted on create → tag) and rejects color. Other types use color (Settings palette hex; omitted on create → hashed from the name) and reject icon. A sent icon or color is written onto an existing match; omitted leaves the stored visual. Invalid palette hex or icon name → 400. Requires settings:tags:write — not settings:write.",
|
|
9485
|
+
method: "PUT",
|
|
9486
|
+
path: "/settings/tags",
|
|
9487
|
+
commandPath: ["settings", "reference", "data", "tags", "upsert"],
|
|
9488
|
+
options: [
|
|
9489
|
+
{
|
|
9490
|
+
name: "type",
|
|
9491
|
+
cliName: "type",
|
|
9492
|
+
optionKey: "type",
|
|
9493
|
+
source: "body",
|
|
9494
|
+
type: "string",
|
|
9495
|
+
required: true,
|
|
9496
|
+
description: "",
|
|
9497
|
+
enumValues: ["service-type", "service-scope", "work-categories"]
|
|
9498
|
+
},
|
|
9499
|
+
{
|
|
9500
|
+
name: "name",
|
|
9501
|
+
cliName: "name",
|
|
9502
|
+
optionKey: "name",
|
|
9503
|
+
source: "body",
|
|
9504
|
+
type: "string",
|
|
9505
|
+
required: true,
|
|
9506
|
+
description: "Display name"
|
|
9507
|
+
},
|
|
9508
|
+
{
|
|
9509
|
+
name: "color",
|
|
9510
|
+
cliName: "color",
|
|
9511
|
+
optionKey: "color",
|
|
9512
|
+
source: "body",
|
|
9513
|
+
type: "string",
|
|
9514
|
+
required: false,
|
|
9515
|
+
description: "",
|
|
9516
|
+
enumValues: [
|
|
9517
|
+
"#1abc9c",
|
|
9518
|
+
"#16a085",
|
|
9519
|
+
"#f1c40f",
|
|
9520
|
+
"#f39c12",
|
|
9521
|
+
"#2ecc71",
|
|
9522
|
+
"#27ae60",
|
|
9523
|
+
"#e67e22",
|
|
9524
|
+
"#d35400",
|
|
9525
|
+
"#3498db",
|
|
9526
|
+
"#2980b9",
|
|
9527
|
+
"#e74c3c",
|
|
9528
|
+
"#c0392b",
|
|
9529
|
+
"#9b59b6",
|
|
9225
9530
|
"#8e44ad",
|
|
9226
9531
|
"#bdc3c7",
|
|
9227
9532
|
"#34495e",
|
|
@@ -11043,6 +11348,15 @@ Requires scope: settings:read`,
|
|
|
11043
11348
|
description: "",
|
|
11044
11349
|
enumValues: ["Billable", "No Charge", "Not Billable"]
|
|
11045
11350
|
},
|
|
11351
|
+
{
|
|
11352
|
+
name: "payable",
|
|
11353
|
+
cliName: "payable",
|
|
11354
|
+
optionKey: "payable",
|
|
11355
|
+
source: "body",
|
|
11356
|
+
type: "boolean",
|
|
11357
|
+
required: false,
|
|
11358
|
+
description: ""
|
|
11359
|
+
},
|
|
11046
11360
|
{
|
|
11047
11361
|
name: "suppliedBySubcontractor",
|
|
11048
11362
|
cliName: "supplied-by-subcontractor",
|
|
@@ -11404,7 +11718,16 @@ Requires scope: settings:read`,
|
|
|
11404
11718
|
enumValues: ["Billable", "No Charge", "Not Billable"]
|
|
11405
11719
|
},
|
|
11406
11720
|
{
|
|
11407
|
-
name: "
|
|
11721
|
+
name: "payable",
|
|
11722
|
+
cliName: "payable",
|
|
11723
|
+
optionKey: "payable",
|
|
11724
|
+
source: "body",
|
|
11725
|
+
type: "boolean",
|
|
11726
|
+
required: false,
|
|
11727
|
+
description: ""
|
|
11728
|
+
},
|
|
11729
|
+
{
|
|
11730
|
+
name: "suppliedBySubcontractor",
|
|
11408
11731
|
cliName: "supplied-by-subcontractor",
|
|
11409
11732
|
optionKey: "suppliedBySubcontractor",
|
|
11410
11733
|
source: "body",
|
|
@@ -11431,30 +11754,333 @@ Requires scope: settings:read`,
|
|
|
11431
11754
|
description: "Custom fields as key-value pairs — validated against tenant field definitions"
|
|
11432
11755
|
},
|
|
11433
11756
|
{
|
|
11434
|
-
name: "trackingCategory1",
|
|
11435
|
-
cliName: "tracking-category1",
|
|
11436
|
-
optionKey: "trackingCategory1",
|
|
11757
|
+
name: "trackingCategory1",
|
|
11758
|
+
cliName: "tracking-category1",
|
|
11759
|
+
optionKey: "trackingCategory1",
|
|
11760
|
+
source: "body",
|
|
11761
|
+
type: "string",
|
|
11762
|
+
required: false,
|
|
11763
|
+
description: ""
|
|
11764
|
+
},
|
|
11765
|
+
{
|
|
11766
|
+
name: "trackingCategory2",
|
|
11767
|
+
cliName: "tracking-category2",
|
|
11768
|
+
optionKey: "trackingCategory2",
|
|
11769
|
+
source: "body",
|
|
11770
|
+
type: "string",
|
|
11771
|
+
required: false,
|
|
11772
|
+
description: ""
|
|
11773
|
+
},
|
|
11774
|
+
{
|
|
11775
|
+
name: "uoms",
|
|
11776
|
+
cliName: "uoms",
|
|
11777
|
+
optionKey: "uoms",
|
|
11778
|
+
source: "body",
|
|
11779
|
+
type: "array",
|
|
11780
|
+
required: false,
|
|
11781
|
+
description: ""
|
|
11782
|
+
},
|
|
11783
|
+
{
|
|
11784
|
+
name: "raw-body",
|
|
11785
|
+
cliName: "raw-body",
|
|
11786
|
+
optionKey: "rawBody",
|
|
11787
|
+
source: "body",
|
|
11788
|
+
type: "object",
|
|
11789
|
+
required: false,
|
|
11790
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
11791
|
+
}
|
|
11792
|
+
],
|
|
11793
|
+
hasRequestBody: true,
|
|
11794
|
+
responseFields: [
|
|
11795
|
+
{
|
|
11796
|
+
name: "item",
|
|
11797
|
+
type: "object"
|
|
11798
|
+
}
|
|
11799
|
+
]
|
|
11800
|
+
},
|
|
11801
|
+
{
|
|
11802
|
+
operationId: "PublicApiItemController_delete",
|
|
11803
|
+
displayName: "Delete item",
|
|
11804
|
+
description: "Deactivate a settings item by ID.",
|
|
11805
|
+
method: "DELETE",
|
|
11806
|
+
path: "/settings/items/{id}",
|
|
11807
|
+
commandPath: ["settings", "items", "delete"],
|
|
11808
|
+
options: [
|
|
11809
|
+
{
|
|
11810
|
+
name: "id",
|
|
11811
|
+
cliName: "id",
|
|
11812
|
+
optionKey: "id",
|
|
11813
|
+
source: "path",
|
|
11814
|
+
type: "string",
|
|
11815
|
+
required: true,
|
|
11816
|
+
description: "Entity ID"
|
|
11817
|
+
}
|
|
11818
|
+
],
|
|
11819
|
+
hasRequestBody: false
|
|
11820
|
+
},
|
|
11821
|
+
{
|
|
11822
|
+
operationId: "PublicApiItemCategoryController_list",
|
|
11823
|
+
displayName: "List item categories",
|
|
11824
|
+
description: "Retrieve active item categories and sub-categories. Use search, name, or id to filter by category/sub-category name or id.",
|
|
11825
|
+
method: "GET",
|
|
11826
|
+
path: "/settings/item-categories",
|
|
11827
|
+
commandPath: ["settings", "items", "item-categories", "list"],
|
|
11828
|
+
options: [
|
|
11829
|
+
{
|
|
11830
|
+
name: "id",
|
|
11831
|
+
cliName: "id",
|
|
11832
|
+
optionKey: "id",
|
|
11833
|
+
source: "query",
|
|
11834
|
+
type: "string",
|
|
11835
|
+
required: false,
|
|
11836
|
+
description: "Alias for search"
|
|
11837
|
+
},
|
|
11838
|
+
{
|
|
11839
|
+
name: "name",
|
|
11840
|
+
cliName: "name",
|
|
11841
|
+
optionKey: "name",
|
|
11842
|
+
source: "query",
|
|
11843
|
+
type: "string",
|
|
11844
|
+
required: false,
|
|
11845
|
+
description: "Alias for search"
|
|
11846
|
+
},
|
|
11847
|
+
{
|
|
11848
|
+
name: "search",
|
|
11849
|
+
cliName: "search",
|
|
11850
|
+
optionKey: "search",
|
|
11851
|
+
source: "query",
|
|
11852
|
+
type: "string",
|
|
11853
|
+
required: false,
|
|
11854
|
+
description: "Filter by category/sub-category name or id"
|
|
11855
|
+
}
|
|
11856
|
+
],
|
|
11857
|
+
hasRequestBody: false,
|
|
11858
|
+
responseFields: [
|
|
11859
|
+
{
|
|
11860
|
+
name: "items",
|
|
11861
|
+
type: "array"
|
|
11862
|
+
}
|
|
11863
|
+
]
|
|
11864
|
+
},
|
|
11865
|
+
{
|
|
11866
|
+
operationId: "PublicApiItemCategoryController_upsert",
|
|
11867
|
+
displayName: "Upsert item category",
|
|
11868
|
+
description: "Create a category/sub-category pair if it does not already exist.",
|
|
11869
|
+
method: "POST",
|
|
11870
|
+
path: "/settings/item-categories/upsert",
|
|
11871
|
+
commandPath: ["settings", "items", "item-categories", "upsert"],
|
|
11872
|
+
options: [
|
|
11873
|
+
{
|
|
11874
|
+
name: "categoryId",
|
|
11875
|
+
cliName: "category-id",
|
|
11876
|
+
optionKey: "categoryId",
|
|
11877
|
+
source: "body",
|
|
11878
|
+
type: "string",
|
|
11879
|
+
required: false,
|
|
11880
|
+
description: "category ID"
|
|
11881
|
+
},
|
|
11882
|
+
{
|
|
11883
|
+
name: "categoryName",
|
|
11884
|
+
cliName: "category-name",
|
|
11885
|
+
optionKey: "categoryName",
|
|
11886
|
+
source: "body",
|
|
11887
|
+
type: "string",
|
|
11888
|
+
required: false,
|
|
11889
|
+
description: ""
|
|
11890
|
+
},
|
|
11891
|
+
{
|
|
11892
|
+
name: "subCategoryId",
|
|
11893
|
+
cliName: "sub-category-id",
|
|
11894
|
+
optionKey: "subCategoryId",
|
|
11895
|
+
source: "body",
|
|
11896
|
+
type: "string",
|
|
11897
|
+
required: false,
|
|
11898
|
+
description: "sub category ID"
|
|
11899
|
+
},
|
|
11900
|
+
{
|
|
11901
|
+
name: "subCategoryName",
|
|
11902
|
+
cliName: "sub-category-name",
|
|
11903
|
+
optionKey: "subCategoryName",
|
|
11904
|
+
source: "body",
|
|
11905
|
+
type: "string",
|
|
11906
|
+
required: false,
|
|
11907
|
+
description: ""
|
|
11908
|
+
},
|
|
11909
|
+
{
|
|
11910
|
+
name: "raw-body",
|
|
11911
|
+
cliName: "raw-body",
|
|
11912
|
+
optionKey: "rawBody",
|
|
11913
|
+
source: "body",
|
|
11914
|
+
type: "object",
|
|
11915
|
+
required: false,
|
|
11916
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
11917
|
+
}
|
|
11918
|
+
],
|
|
11919
|
+
hasRequestBody: true,
|
|
11920
|
+
responseFields: [
|
|
11921
|
+
{
|
|
11922
|
+
name: "category",
|
|
11923
|
+
type: "object"
|
|
11924
|
+
}
|
|
11925
|
+
]
|
|
11926
|
+
},
|
|
11927
|
+
{
|
|
11928
|
+
operationId: "PublicApiUoMController_list",
|
|
11929
|
+
displayName: "List UOMs",
|
|
11930
|
+
description: "Retrieve active units of measure for item create/update.",
|
|
11931
|
+
method: "GET",
|
|
11932
|
+
path: "/settings/uoms",
|
|
11933
|
+
commandPath: ["settings", "items", "uoms", "list"],
|
|
11934
|
+
options: [],
|
|
11935
|
+
hasRequestBody: false,
|
|
11936
|
+
responseFields: [
|
|
11937
|
+
{
|
|
11938
|
+
name: "items",
|
|
11939
|
+
type: "array"
|
|
11940
|
+
}
|
|
11941
|
+
]
|
|
11942
|
+
},
|
|
11943
|
+
{
|
|
11944
|
+
operationId: "PublicApiCustomFieldController_listJobCustomFields",
|
|
11945
|
+
displayName: "List job custom fields",
|
|
11946
|
+
description: "Retrieve configured custom fields that may be used in Job customFields payloads.",
|
|
11947
|
+
method: "GET",
|
|
11948
|
+
path: "/settings/custom-fields/jobs",
|
|
11949
|
+
commandPath: ["settings", "custom", "fields", "custom-fields", "jobs", "list"],
|
|
11950
|
+
options: [],
|
|
11951
|
+
hasRequestBody: false,
|
|
11952
|
+
responseFields: [
|
|
11953
|
+
{
|
|
11954
|
+
name: "items",
|
|
11955
|
+
type: "array"
|
|
11956
|
+
}
|
|
11957
|
+
]
|
|
11958
|
+
},
|
|
11959
|
+
{
|
|
11960
|
+
operationId: "PublicApiCustomFieldController_listStageCustomFields",
|
|
11961
|
+
displayName: "List stage custom fields",
|
|
11962
|
+
description: "Retrieve configured custom fields that may be used in Stage customFields payloads.",
|
|
11963
|
+
method: "GET",
|
|
11964
|
+
path: "/settings/custom-fields/stages",
|
|
11965
|
+
commandPath: ["settings", "custom", "fields", "custom-fields", "stages", "list"],
|
|
11966
|
+
options: [],
|
|
11967
|
+
hasRequestBody: false,
|
|
11968
|
+
responseFields: [
|
|
11969
|
+
{
|
|
11970
|
+
name: "items",
|
|
11971
|
+
type: "array"
|
|
11972
|
+
}
|
|
11973
|
+
]
|
|
11974
|
+
},
|
|
11975
|
+
{
|
|
11976
|
+
operationId: "PublicApiCustomFieldController_listAccountCustomFields",
|
|
11977
|
+
displayName: "List account custom fields",
|
|
11978
|
+
description: "Retrieve configured custom fields that may be used in CRM account customFields payloads.",
|
|
11979
|
+
method: "GET",
|
|
11980
|
+
path: "/settings/custom-fields/accounts",
|
|
11981
|
+
commandPath: ["settings", "custom", "fields", "custom-fields", "accounts", "list"],
|
|
11982
|
+
options: [],
|
|
11983
|
+
hasRequestBody: false,
|
|
11984
|
+
responseFields: [
|
|
11985
|
+
{
|
|
11986
|
+
name: "items",
|
|
11987
|
+
type: "array"
|
|
11988
|
+
}
|
|
11989
|
+
]
|
|
11990
|
+
},
|
|
11991
|
+
{
|
|
11992
|
+
operationId: "PublicApiCustomFieldController_listItemCustomFields",
|
|
11993
|
+
displayName: "List item custom fields",
|
|
11994
|
+
description: "Retrieve configured custom fields that may be used in settings item customFields payloads.",
|
|
11995
|
+
method: "GET",
|
|
11996
|
+
path: "/settings/custom-fields/items",
|
|
11997
|
+
commandPath: ["settings", "custom", "fields", "custom-fields", "items", "list"],
|
|
11998
|
+
options: [],
|
|
11999
|
+
hasRequestBody: false,
|
|
12000
|
+
responseFields: [
|
|
12001
|
+
{
|
|
12002
|
+
name: "items",
|
|
12003
|
+
type: "array"
|
|
12004
|
+
}
|
|
12005
|
+
]
|
|
12006
|
+
},
|
|
12007
|
+
{
|
|
12008
|
+
operationId: "PublicApiPortalRoleController_listClientPortal",
|
|
12009
|
+
displayName: "List client portal roles",
|
|
12010
|
+
description: "Roles assignable to customer login contacts (UserType.Client). Includes custom client roles; includes built-in system client roles only when Enable System Security Roles is on for the tenant. Use item.id as roleId when login is true on contact create/invite.",
|
|
12011
|
+
method: "GET",
|
|
12012
|
+
path: "/settings/roles/client-portal",
|
|
12013
|
+
commandPath: ["settings", "reference", "data", "roles", "client-portal", "list"],
|
|
12014
|
+
options: [],
|
|
12015
|
+
hasRequestBody: false,
|
|
12016
|
+
responseFields: [
|
|
12017
|
+
{
|
|
12018
|
+
name: "items",
|
|
12019
|
+
type: "array"
|
|
12020
|
+
}
|
|
12021
|
+
]
|
|
12022
|
+
},
|
|
12023
|
+
{
|
|
12024
|
+
operationId: "PublicApiPortalRoleController_listContractorPortal",
|
|
12025
|
+
displayName: "List contractor portal roles",
|
|
12026
|
+
description: "Roles assignable to contractor login contacts (UserType.Subcontractor). Includes custom contractor roles; includes built-in system contractor roles only when Enable System Security Roles is on for the tenant. Use item.id as roleId when login is true on contact create/invite.",
|
|
12027
|
+
method: "GET",
|
|
12028
|
+
path: "/settings/roles/contractor-portal",
|
|
12029
|
+
commandPath: ["settings", "reference", "data", "roles", "contractor-portal", "list"],
|
|
12030
|
+
options: [],
|
|
12031
|
+
hasRequestBody: false,
|
|
12032
|
+
responseFields: [
|
|
12033
|
+
{
|
|
12034
|
+
name: "items",
|
|
12035
|
+
type: "array"
|
|
12036
|
+
}
|
|
12037
|
+
]
|
|
12038
|
+
},
|
|
12039
|
+
{
|
|
12040
|
+
operationId: "PublicAttachmentController_createUploadSession",
|
|
12041
|
+
displayName: "Create upload session",
|
|
12042
|
+
description: `Creates an upload session and returns a SAS URL for direct upload to Azure Blob Storage.
|
|
12043
|
+
|
|
12044
|
+
**Upload Flow:**
|
|
12045
|
+
1. POST to this endpoint with file metadata
|
|
12046
|
+
2. Use the returned \`uploadUrl\` to PUT your file directly to blob storage
|
|
12047
|
+
3. Include the required headers from the response in your PUT request
|
|
12048
|
+
4. Store the \`attachment.id\` for later reference
|
|
12049
|
+
|
|
12050
|
+
**Constraints:**
|
|
12051
|
+
- Maximum file size: 50MB
|
|
12052
|
+
- Allowed content types: application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, text/plain, application/vnd.ms-excel.sheet.macroEnabled.12...
|
|
12053
|
+
- Allowed extensions: .doc, .docx, .pdf, .txt, .xlsx, .xls, .xlsm, .csv, .json, .xml...
|
|
12054
|
+
- Upload URL expires in 20 minutes`,
|
|
12055
|
+
method: "POST",
|
|
12056
|
+
path: "/attachments",
|
|
12057
|
+
commandPath: ["attachments", "create-upload-session"],
|
|
12058
|
+
options: [
|
|
12059
|
+
{
|
|
12060
|
+
name: "fileName",
|
|
12061
|
+
cliName: "file-name",
|
|
12062
|
+
optionKey: "fileName",
|
|
11437
12063
|
source: "body",
|
|
11438
12064
|
type: "string",
|
|
11439
|
-
required:
|
|
12065
|
+
required: true,
|
|
11440
12066
|
description: ""
|
|
11441
12067
|
},
|
|
11442
12068
|
{
|
|
11443
|
-
name: "
|
|
11444
|
-
cliName: "
|
|
11445
|
-
optionKey: "
|
|
12069
|
+
name: "contentType",
|
|
12070
|
+
cliName: "content-type",
|
|
12071
|
+
optionKey: "contentType",
|
|
11446
12072
|
source: "body",
|
|
11447
12073
|
type: "string",
|
|
11448
|
-
required:
|
|
12074
|
+
required: true,
|
|
11449
12075
|
description: ""
|
|
11450
12076
|
},
|
|
11451
12077
|
{
|
|
11452
|
-
name: "
|
|
11453
|
-
cliName: "
|
|
11454
|
-
optionKey: "
|
|
12078
|
+
name: "size",
|
|
12079
|
+
cliName: "size",
|
|
12080
|
+
optionKey: "size",
|
|
11455
12081
|
source: "body",
|
|
11456
|
-
type: "
|
|
11457
|
-
required:
|
|
12082
|
+
type: "integer",
|
|
12083
|
+
required: true,
|
|
11458
12084
|
description: ""
|
|
11459
12085
|
},
|
|
11460
12086
|
{
|
|
@@ -11470,118 +12096,330 @@ Requires scope: settings:read`,
|
|
|
11470
12096
|
hasRequestBody: true,
|
|
11471
12097
|
responseFields: [
|
|
11472
12098
|
{
|
|
11473
|
-
name: "
|
|
12099
|
+
name: "uploadUrl",
|
|
12100
|
+
type: "string"
|
|
12101
|
+
},
|
|
12102
|
+
{
|
|
12103
|
+
name: "headers",
|
|
12104
|
+
type: "object"
|
|
12105
|
+
},
|
|
12106
|
+
{
|
|
12107
|
+
name: "expiresAt",
|
|
12108
|
+
type: "string"
|
|
12109
|
+
},
|
|
12110
|
+
{
|
|
12111
|
+
name: "attachment",
|
|
11474
12112
|
type: "object"
|
|
11475
12113
|
}
|
|
11476
12114
|
]
|
|
11477
12115
|
},
|
|
11478
12116
|
{
|
|
11479
|
-
operationId: "
|
|
11480
|
-
displayName: "
|
|
11481
|
-
description:
|
|
11482
|
-
|
|
11483
|
-
|
|
11484
|
-
|
|
12117
|
+
operationId: "PublicAttachmentController_download",
|
|
12118
|
+
displayName: "Download attachment",
|
|
12119
|
+
description: `Downloads an attachment by redirecting to a time-limited SAS URL.
|
|
12120
|
+
|
|
12121
|
+
**Response:**
|
|
12122
|
+
- 302 redirect to Azure Blob Storage with SAS token
|
|
12123
|
+
- Content-Disposition header set for proper filename
|
|
12124
|
+
|
|
12125
|
+
**Note:** The SAS URL expires after 20 minutes. If expired, request a new download.`,
|
|
12126
|
+
method: "GET",
|
|
12127
|
+
path: "/attachments/{encodedId}",
|
|
12128
|
+
commandPath: ["attachments", "get"],
|
|
11485
12129
|
options: [
|
|
11486
12130
|
{
|
|
11487
|
-
name: "
|
|
11488
|
-
cliName: "id",
|
|
11489
|
-
optionKey: "
|
|
12131
|
+
name: "encodedId",
|
|
12132
|
+
cliName: "encoded-id",
|
|
12133
|
+
optionKey: "encodedId",
|
|
11490
12134
|
source: "path",
|
|
11491
12135
|
type: "string",
|
|
11492
12136
|
required: true,
|
|
11493
|
-
description: "
|
|
12137
|
+
description: "Encoded attachment ID from upload response"
|
|
11494
12138
|
}
|
|
11495
12139
|
],
|
|
11496
12140
|
hasRequestBody: false
|
|
11497
12141
|
},
|
|
11498
12142
|
{
|
|
11499
|
-
operationId: "
|
|
11500
|
-
displayName: "List
|
|
11501
|
-
description: "
|
|
12143
|
+
operationId: "PublicJobActivitiesController_list",
|
|
12144
|
+
displayName: "List activities (Jobs)",
|
|
12145
|
+
description: "List activities (Jobs)",
|
|
11502
12146
|
method: "GET",
|
|
11503
|
-
path: "/
|
|
11504
|
-
commandPath: ["
|
|
12147
|
+
path: "/jobs/{jobId}/activities",
|
|
12148
|
+
commandPath: ["jobs", "activities", "list"],
|
|
12149
|
+
options: [
|
|
12150
|
+
{
|
|
12151
|
+
name: "jobId",
|
|
12152
|
+
cliName: "job-id",
|
|
12153
|
+
optionKey: "jobId",
|
|
12154
|
+
source: "path",
|
|
12155
|
+
type: "string",
|
|
12156
|
+
required: true,
|
|
12157
|
+
description: "Job ID or job number (e.g. J12345)"
|
|
12158
|
+
},
|
|
12159
|
+
{
|
|
12160
|
+
name: "kind",
|
|
12161
|
+
cliName: "kind",
|
|
12162
|
+
optionKey: "kind",
|
|
12163
|
+
source: "query",
|
|
12164
|
+
type: "array",
|
|
12165
|
+
required: false,
|
|
12166
|
+
description: "Filter by kind (repeat for multiple kinds)"
|
|
12167
|
+
},
|
|
12168
|
+
{
|
|
12169
|
+
name: "cursor",
|
|
12170
|
+
cliName: "cursor",
|
|
12171
|
+
optionKey: "cursor",
|
|
12172
|
+
source: "query",
|
|
12173
|
+
type: "string",
|
|
12174
|
+
required: false,
|
|
12175
|
+
description: "Pagination cursor from previous response"
|
|
12176
|
+
},
|
|
12177
|
+
{
|
|
12178
|
+
name: "limit",
|
|
12179
|
+
cliName: "limit",
|
|
12180
|
+
optionKey: "limit",
|
|
12181
|
+
source: "query",
|
|
12182
|
+
type: "number",
|
|
12183
|
+
required: false,
|
|
12184
|
+
description: "Maximum results to return (1-200)"
|
|
12185
|
+
}
|
|
12186
|
+
],
|
|
12187
|
+
hasRequestBody: false,
|
|
12188
|
+
responseFields: [
|
|
12189
|
+
{
|
|
12190
|
+
name: "items",
|
|
12191
|
+
type: "array"
|
|
12192
|
+
},
|
|
12193
|
+
{
|
|
12194
|
+
name: "pagination",
|
|
12195
|
+
type: "object"
|
|
12196
|
+
}
|
|
12197
|
+
]
|
|
12198
|
+
},
|
|
12199
|
+
{
|
|
12200
|
+
operationId: "PublicJobActivitiesController_listTemplates",
|
|
12201
|
+
displayName: "List email or SMS templates for this record (Jobs)",
|
|
12202
|
+
description: "Published templates of the channel this record may send: its own entity's (and, on a stage, the job's), narrowed by each template's company, job type and work category scope exactly as the send applies it. Pass an `id` as `templateId` to the email or SMS create or preview.",
|
|
12203
|
+
method: "GET",
|
|
12204
|
+
path: "/jobs/{jobId}/activities/templates",
|
|
12205
|
+
commandPath: ["jobs", "activities", "templates", "list"],
|
|
12206
|
+
options: [
|
|
12207
|
+
{
|
|
12208
|
+
name: "jobId",
|
|
12209
|
+
cliName: "job-id",
|
|
12210
|
+
optionKey: "jobId",
|
|
12211
|
+
source: "path",
|
|
12212
|
+
type: "string",
|
|
12213
|
+
required: true,
|
|
12214
|
+
description: "Job ID or job number (e.g. J12345)"
|
|
12215
|
+
},
|
|
12216
|
+
{
|
|
12217
|
+
name: "channel",
|
|
12218
|
+
cliName: "channel",
|
|
12219
|
+
optionKey: "channel",
|
|
12220
|
+
source: "query",
|
|
12221
|
+
type: "string",
|
|
12222
|
+
required: true,
|
|
12223
|
+
description: "Message channel",
|
|
12224
|
+
enumValues: ["email", "sms"]
|
|
12225
|
+
}
|
|
12226
|
+
],
|
|
12227
|
+
hasRequestBody: false,
|
|
12228
|
+
responseFields: [
|
|
12229
|
+
{
|
|
12230
|
+
name: "items",
|
|
12231
|
+
type: "array"
|
|
12232
|
+
}
|
|
12233
|
+
]
|
|
12234
|
+
},
|
|
12235
|
+
{
|
|
12236
|
+
operationId: "PublicJobActivitiesController_listMergeFields",
|
|
12237
|
+
displayName: "List merge fields for this record's templates (Jobs)",
|
|
12238
|
+
description: 'The merge fields this record\'s email and SMS templates may use, custom fields included, with keys as templates name them (`<span data-wb-merge="job.jobNumber">` or `{{job.jobNumber}}`).',
|
|
12239
|
+
method: "GET",
|
|
12240
|
+
path: "/jobs/{jobId}/activities/merge-fields",
|
|
12241
|
+
commandPath: ["jobs", "activities", "merge-fields", "list"],
|
|
12242
|
+
options: [
|
|
12243
|
+
{
|
|
12244
|
+
name: "jobId",
|
|
12245
|
+
cliName: "job-id",
|
|
12246
|
+
optionKey: "jobId",
|
|
12247
|
+
source: "path",
|
|
12248
|
+
type: "string",
|
|
12249
|
+
required: true,
|
|
12250
|
+
description: "Job ID or job number (e.g. J12345)"
|
|
12251
|
+
}
|
|
12252
|
+
],
|
|
12253
|
+
hasRequestBody: false,
|
|
12254
|
+
responseFields: [
|
|
12255
|
+
{
|
|
12256
|
+
name: "items",
|
|
12257
|
+
type: "array"
|
|
12258
|
+
}
|
|
12259
|
+
]
|
|
12260
|
+
},
|
|
12261
|
+
{
|
|
12262
|
+
operationId: "PublicJobActivitiesController_getById",
|
|
12263
|
+
displayName: "Get activity by ID (Jobs)",
|
|
12264
|
+
description: "Get activity by ID (Jobs)",
|
|
12265
|
+
method: "GET",
|
|
12266
|
+
path: "/jobs/{jobId}/activities/{id}",
|
|
12267
|
+
commandPath: ["jobs", "activities", "get"],
|
|
11505
12268
|
options: [
|
|
12269
|
+
{
|
|
12270
|
+
name: "jobId",
|
|
12271
|
+
cliName: "job-id",
|
|
12272
|
+
optionKey: "jobId",
|
|
12273
|
+
source: "path",
|
|
12274
|
+
type: "string",
|
|
12275
|
+
required: true,
|
|
12276
|
+
description: "Job ID or job number (e.g. J12345)"
|
|
12277
|
+
},
|
|
11506
12278
|
{
|
|
11507
12279
|
name: "id",
|
|
11508
12280
|
cliName: "id",
|
|
11509
12281
|
optionKey: "id",
|
|
11510
|
-
source: "
|
|
12282
|
+
source: "path",
|
|
11511
12283
|
type: "string",
|
|
11512
|
-
required:
|
|
11513
|
-
description: "
|
|
12284
|
+
required: true,
|
|
12285
|
+
description: "Activity ID"
|
|
12286
|
+
}
|
|
12287
|
+
],
|
|
12288
|
+
hasRequestBody: false,
|
|
12289
|
+
responseFields: [
|
|
12290
|
+
{
|
|
12291
|
+
name: "id",
|
|
12292
|
+
type: "string",
|
|
12293
|
+
description: "Entity ID"
|
|
12294
|
+
},
|
|
12295
|
+
{
|
|
12296
|
+
name: "kind",
|
|
12297
|
+
type: "string"
|
|
12298
|
+
},
|
|
12299
|
+
{
|
|
12300
|
+
name: "body",
|
|
12301
|
+
type: "string",
|
|
12302
|
+
description: "Message body content (HTML supported for email)"
|
|
12303
|
+
},
|
|
12304
|
+
{
|
|
12305
|
+
name: "attachments",
|
|
12306
|
+
type: "string"
|
|
12307
|
+
},
|
|
12308
|
+
{
|
|
12309
|
+
name: "createdAt",
|
|
12310
|
+
type: "string"
|
|
12311
|
+
},
|
|
12312
|
+
{
|
|
12313
|
+
name: "updatedAt",
|
|
12314
|
+
type: "string",
|
|
12315
|
+
description: "For optimistic concurrency — update fails if entity was modified after this timestamp"
|
|
12316
|
+
},
|
|
12317
|
+
{
|
|
12318
|
+
name: "createdBy",
|
|
12319
|
+
type: "string"
|
|
12320
|
+
},
|
|
12321
|
+
{
|
|
12322
|
+
name: "labels",
|
|
12323
|
+
type: "string"
|
|
11514
12324
|
},
|
|
11515
12325
|
{
|
|
11516
|
-
name: "
|
|
11517
|
-
|
|
11518
|
-
|
|
11519
|
-
|
|
12326
|
+
name: "sharing",
|
|
12327
|
+
type: "string",
|
|
12328
|
+
description: "Sharing options — control visibility to customer portal and field app"
|
|
12329
|
+
}
|
|
12330
|
+
]
|
|
12331
|
+
},
|
|
12332
|
+
{
|
|
12333
|
+
operationId: "PublicJobActivitiesController_delete",
|
|
12334
|
+
displayName: "Delete activity (Jobs)",
|
|
12335
|
+
description: "Delete activity (Jobs)",
|
|
12336
|
+
method: "DELETE",
|
|
12337
|
+
path: "/jobs/{jobId}/activities/{id}",
|
|
12338
|
+
commandPath: ["jobs", "activities", "delete"],
|
|
12339
|
+
options: [
|
|
12340
|
+
{
|
|
12341
|
+
name: "jobId",
|
|
12342
|
+
cliName: "job-id",
|
|
12343
|
+
optionKey: "jobId",
|
|
12344
|
+
source: "path",
|
|
11520
12345
|
type: "string",
|
|
11521
|
-
required:
|
|
11522
|
-
description: "
|
|
12346
|
+
required: true,
|
|
12347
|
+
description: "Job ID"
|
|
11523
12348
|
},
|
|
11524
12349
|
{
|
|
11525
|
-
name: "
|
|
11526
|
-
cliName: "
|
|
11527
|
-
optionKey: "
|
|
11528
|
-
source: "
|
|
12350
|
+
name: "id",
|
|
12351
|
+
cliName: "id",
|
|
12352
|
+
optionKey: "id",
|
|
12353
|
+
source: "path",
|
|
11529
12354
|
type: "string",
|
|
11530
|
-
required:
|
|
11531
|
-
description: "
|
|
12355
|
+
required: true,
|
|
12356
|
+
description: "Activity ID"
|
|
11532
12357
|
}
|
|
11533
12358
|
],
|
|
11534
|
-
hasRequestBody: false
|
|
11535
|
-
responseFields: [
|
|
11536
|
-
{
|
|
11537
|
-
name: "items",
|
|
11538
|
-
type: "array"
|
|
11539
|
-
}
|
|
11540
|
-
]
|
|
12359
|
+
hasRequestBody: false
|
|
11541
12360
|
},
|
|
11542
12361
|
{
|
|
11543
|
-
operationId: "
|
|
11544
|
-
displayName: "
|
|
11545
|
-
description: "Create
|
|
12362
|
+
operationId: "PublicJobActivitiesController_createNote",
|
|
12363
|
+
displayName: "Create note activity (Jobs)",
|
|
12364
|
+
description: "Create note activity (Jobs)",
|
|
11546
12365
|
method: "POST",
|
|
11547
|
-
path: "/
|
|
11548
|
-
commandPath: ["
|
|
12366
|
+
path: "/jobs/{jobId}/activities/note",
|
|
12367
|
+
commandPath: ["jobs", "activities", "note", "create"],
|
|
11549
12368
|
options: [
|
|
11550
12369
|
{
|
|
11551
|
-
name: "
|
|
11552
|
-
cliName: "
|
|
11553
|
-
optionKey: "
|
|
12370
|
+
name: "jobId",
|
|
12371
|
+
cliName: "job-id",
|
|
12372
|
+
optionKey: "jobId",
|
|
12373
|
+
source: "path",
|
|
12374
|
+
type: "string",
|
|
12375
|
+
required: true,
|
|
12376
|
+
description: "Job ID or job number (e.g. J12345)"
|
|
12377
|
+
},
|
|
12378
|
+
{
|
|
12379
|
+
name: "body",
|
|
12380
|
+
cliName: "body",
|
|
12381
|
+
optionKey: "body",
|
|
11554
12382
|
source: "body",
|
|
11555
12383
|
type: "string",
|
|
11556
|
-
required:
|
|
11557
|
-
description: "
|
|
12384
|
+
required: true,
|
|
12385
|
+
description: "Message body content (HTML supported for email)"
|
|
11558
12386
|
},
|
|
11559
12387
|
{
|
|
11560
|
-
name: "
|
|
11561
|
-
cliName: "
|
|
11562
|
-
optionKey: "
|
|
12388
|
+
name: "title",
|
|
12389
|
+
cliName: "title",
|
|
12390
|
+
optionKey: "title",
|
|
11563
12391
|
source: "body",
|
|
11564
12392
|
type: "string",
|
|
11565
12393
|
required: false,
|
|
11566
12394
|
description: ""
|
|
11567
12395
|
},
|
|
11568
12396
|
{
|
|
11569
|
-
name: "
|
|
11570
|
-
cliName: "
|
|
11571
|
-
optionKey: "
|
|
12397
|
+
name: "labelIds",
|
|
12398
|
+
cliName: "label-ids",
|
|
12399
|
+
optionKey: "labelIds",
|
|
11572
12400
|
source: "body",
|
|
11573
|
-
type: "
|
|
12401
|
+
type: "array",
|
|
11574
12402
|
required: false,
|
|
11575
|
-
description:
|
|
12403
|
+
description: 'Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")',
|
|
12404
|
+
lookupEndpoint: "/settings/tags"
|
|
11576
12405
|
},
|
|
11577
12406
|
{
|
|
11578
|
-
name: "
|
|
11579
|
-
cliName: "
|
|
11580
|
-
optionKey: "
|
|
12407
|
+
name: "attachmentIds",
|
|
12408
|
+
cliName: "attachment-ids",
|
|
12409
|
+
optionKey: "attachmentIds",
|
|
11581
12410
|
source: "body",
|
|
11582
|
-
type: "
|
|
12411
|
+
type: "array",
|
|
11583
12412
|
required: false,
|
|
11584
|
-
description: ""
|
|
12413
|
+
description: 'Attachment IDs from the upload endpoint (comma-separated, e.g. "id1,id2")'
|
|
12414
|
+
},
|
|
12415
|
+
{
|
|
12416
|
+
name: "sharing",
|
|
12417
|
+
cliName: "sharing",
|
|
12418
|
+
optionKey: "sharing",
|
|
12419
|
+
source: "body",
|
|
12420
|
+
type: "object",
|
|
12421
|
+
required: false,
|
|
12422
|
+
description: "Sharing options — control visibility to customer portal and field app"
|
|
11585
12423
|
},
|
|
11586
12424
|
{
|
|
11587
12425
|
name: "raw-body",
|
|
@@ -11596,169 +12434,146 @@ Requires scope: settings:read`,
|
|
|
11596
12434
|
hasRequestBody: true,
|
|
11597
12435
|
responseFields: [
|
|
11598
12436
|
{
|
|
11599
|
-
name: "
|
|
11600
|
-
type: "
|
|
11601
|
-
|
|
11602
|
-
|
|
11603
|
-
},
|
|
11604
|
-
{
|
|
11605
|
-
operationId: "PublicApiUoMController_list",
|
|
11606
|
-
displayName: "List UOMs",
|
|
11607
|
-
description: "Retrieve active units of measure for item create/update.",
|
|
11608
|
-
method: "GET",
|
|
11609
|
-
path: "/settings/uoms",
|
|
11610
|
-
commandPath: ["settings", "items", "uoms", "list"],
|
|
11611
|
-
options: [],
|
|
11612
|
-
hasRequestBody: false,
|
|
11613
|
-
responseFields: [
|
|
12437
|
+
name: "id",
|
|
12438
|
+
type: "string",
|
|
12439
|
+
description: "Entity ID"
|
|
12440
|
+
},
|
|
11614
12441
|
{
|
|
11615
|
-
name: "
|
|
11616
|
-
type: "
|
|
11617
|
-
}
|
|
11618
|
-
]
|
|
11619
|
-
},
|
|
11620
|
-
{
|
|
11621
|
-
operationId: "PublicApiCustomFieldController_listJobCustomFields",
|
|
11622
|
-
displayName: "List job custom fields",
|
|
11623
|
-
description: "Retrieve configured custom fields that may be used in Job customFields payloads.",
|
|
11624
|
-
method: "GET",
|
|
11625
|
-
path: "/settings/custom-fields/jobs",
|
|
11626
|
-
commandPath: ["settings", "custom", "fields", "custom-fields", "jobs", "list"],
|
|
11627
|
-
options: [],
|
|
11628
|
-
hasRequestBody: false,
|
|
11629
|
-
responseFields: [
|
|
12442
|
+
name: "kind",
|
|
12443
|
+
type: "string"
|
|
12444
|
+
},
|
|
11630
12445
|
{
|
|
11631
|
-
name: "
|
|
11632
|
-
type: "
|
|
11633
|
-
|
|
11634
|
-
|
|
11635
|
-
},
|
|
11636
|
-
{
|
|
11637
|
-
operationId: "PublicApiCustomFieldController_listStageCustomFields",
|
|
11638
|
-
displayName: "List stage custom fields",
|
|
11639
|
-
description: "Retrieve configured custom fields that may be used in Stage customFields payloads.",
|
|
11640
|
-
method: "GET",
|
|
11641
|
-
path: "/settings/custom-fields/stages",
|
|
11642
|
-
commandPath: ["settings", "custom", "fields", "custom-fields", "stages", "list"],
|
|
11643
|
-
options: [],
|
|
11644
|
-
hasRequestBody: false,
|
|
11645
|
-
responseFields: [
|
|
12446
|
+
name: "body",
|
|
12447
|
+
type: "string",
|
|
12448
|
+
description: "Message body content (HTML supported for email)"
|
|
12449
|
+
},
|
|
11646
12450
|
{
|
|
11647
|
-
name: "
|
|
11648
|
-
type: "
|
|
11649
|
-
}
|
|
11650
|
-
]
|
|
11651
|
-
},
|
|
11652
|
-
{
|
|
11653
|
-
operationId: "PublicApiCustomFieldController_listAccountCustomFields",
|
|
11654
|
-
displayName: "List account custom fields",
|
|
11655
|
-
description: "Retrieve configured custom fields that may be used in CRM account customFields payloads.",
|
|
11656
|
-
method: "GET",
|
|
11657
|
-
path: "/settings/custom-fields/accounts",
|
|
11658
|
-
commandPath: ["settings", "custom", "fields", "custom-fields", "accounts", "list"],
|
|
11659
|
-
options: [],
|
|
11660
|
-
hasRequestBody: false,
|
|
11661
|
-
responseFields: [
|
|
12451
|
+
name: "attachments",
|
|
12452
|
+
type: "string"
|
|
12453
|
+
},
|
|
11662
12454
|
{
|
|
11663
|
-
name: "
|
|
11664
|
-
type: "
|
|
11665
|
-
}
|
|
11666
|
-
]
|
|
11667
|
-
},
|
|
11668
|
-
{
|
|
11669
|
-
operationId: "PublicApiCustomFieldController_listItemCustomFields",
|
|
11670
|
-
displayName: "List item custom fields",
|
|
11671
|
-
description: "Retrieve configured custom fields that may be used in settings item customFields payloads.",
|
|
11672
|
-
method: "GET",
|
|
11673
|
-
path: "/settings/custom-fields/items",
|
|
11674
|
-
commandPath: ["settings", "custom", "fields", "custom-fields", "items", "list"],
|
|
11675
|
-
options: [],
|
|
11676
|
-
hasRequestBody: false,
|
|
11677
|
-
responseFields: [
|
|
12455
|
+
name: "createdAt",
|
|
12456
|
+
type: "string"
|
|
12457
|
+
},
|
|
11678
12458
|
{
|
|
11679
|
-
name: "
|
|
11680
|
-
type: "
|
|
11681
|
-
|
|
11682
|
-
|
|
11683
|
-
},
|
|
11684
|
-
{
|
|
11685
|
-
operationId: "PublicApiPortalRoleController_listClientPortal",
|
|
11686
|
-
displayName: "List client portal roles",
|
|
11687
|
-
description: "Roles assignable to customer login contacts (UserType.Client). Includes custom client roles; includes built-in system client roles only when Enable System Security Roles is on for the tenant. Use item.id as roleId when login is true on contact create/invite.",
|
|
11688
|
-
method: "GET",
|
|
11689
|
-
path: "/settings/roles/client-portal",
|
|
11690
|
-
commandPath: ["settings", "reference", "data", "roles", "client-portal", "list"],
|
|
11691
|
-
options: [],
|
|
11692
|
-
hasRequestBody: false,
|
|
11693
|
-
responseFields: [
|
|
12459
|
+
name: "updatedAt",
|
|
12460
|
+
type: "string",
|
|
12461
|
+
description: "For optimistic concurrency — update fails if entity was modified after this timestamp"
|
|
12462
|
+
},
|
|
11694
12463
|
{
|
|
11695
|
-
name: "
|
|
11696
|
-
type: "
|
|
11697
|
-
}
|
|
11698
|
-
]
|
|
11699
|
-
},
|
|
11700
|
-
{
|
|
11701
|
-
operationId: "PublicApiPortalRoleController_listContractorPortal",
|
|
11702
|
-
displayName: "List contractor portal roles",
|
|
11703
|
-
description: "Roles assignable to contractor login contacts (UserType.Subcontractor). Includes custom contractor roles; includes built-in system contractor roles only when Enable System Security Roles is on for the tenant. Use item.id as roleId when login is true on contact create/invite.",
|
|
11704
|
-
method: "GET",
|
|
11705
|
-
path: "/settings/roles/contractor-portal",
|
|
11706
|
-
commandPath: ["settings", "reference", "data", "roles", "contractor-portal", "list"],
|
|
11707
|
-
options: [],
|
|
11708
|
-
hasRequestBody: false,
|
|
11709
|
-
responseFields: [
|
|
12464
|
+
name: "createdBy",
|
|
12465
|
+
type: "string"
|
|
12466
|
+
},
|
|
11710
12467
|
{
|
|
11711
|
-
name: "
|
|
11712
|
-
type: "
|
|
11713
|
-
}
|
|
11714
|
-
|
|
11715
|
-
|
|
11716
|
-
|
|
11717
|
-
|
|
11718
|
-
|
|
11719
|
-
|
|
11720
|
-
|
|
11721
|
-
|
|
11722
|
-
|
|
11723
|
-
|
|
11724
|
-
|
|
11725
|
-
4. Store the \`attachment.id\` for later reference
|
|
11726
|
-
|
|
11727
|
-
**Constraints:**
|
|
11728
|
-
- Maximum file size: 50MB
|
|
11729
|
-
- Allowed content types: application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, text/plain, application/vnd.ms-excel.sheet.macroEnabled.12...
|
|
11730
|
-
- Allowed extensions: .doc, .docx, .pdf, .txt, .xlsx, .xls, .xlsm, .csv, .json, .xml...
|
|
11731
|
-
- Upload URL expires in 20 minutes`,
|
|
12468
|
+
name: "labels",
|
|
12469
|
+
type: "string"
|
|
12470
|
+
},
|
|
12471
|
+
{
|
|
12472
|
+
name: "sharing",
|
|
12473
|
+
type: "string",
|
|
12474
|
+
description: "Sharing options — control visibility to customer portal and field app"
|
|
12475
|
+
}
|
|
12476
|
+
]
|
|
12477
|
+
},
|
|
12478
|
+
{
|
|
12479
|
+
operationId: "PublicJobActivitiesController_createEmail",
|
|
12480
|
+
displayName: "Create email activity (Jobs)",
|
|
12481
|
+
description: "Create email activity (Jobs)",
|
|
11732
12482
|
method: "POST",
|
|
11733
|
-
path: "/
|
|
11734
|
-
commandPath: ["
|
|
12483
|
+
path: "/jobs/{jobId}/activities/email",
|
|
12484
|
+
commandPath: ["jobs", "activities", "email", "create"],
|
|
11735
12485
|
options: [
|
|
11736
12486
|
{
|
|
11737
|
-
name: "
|
|
11738
|
-
cliName: "
|
|
11739
|
-
optionKey: "
|
|
11740
|
-
source: "
|
|
12487
|
+
name: "jobId",
|
|
12488
|
+
cliName: "job-id",
|
|
12489
|
+
optionKey: "jobId",
|
|
12490
|
+
source: "path",
|
|
11741
12491
|
type: "string",
|
|
11742
12492
|
required: true,
|
|
11743
|
-
description: ""
|
|
12493
|
+
description: "Job ID"
|
|
11744
12494
|
},
|
|
11745
12495
|
{
|
|
11746
|
-
name: "
|
|
11747
|
-
cliName: "
|
|
11748
|
-
optionKey: "
|
|
12496
|
+
name: "templateId",
|
|
12497
|
+
cliName: "template-id",
|
|
12498
|
+
optionKey: "templateId",
|
|
11749
12499
|
source: "body",
|
|
11750
12500
|
type: "string",
|
|
11751
|
-
required:
|
|
11752
|
-
description: ""
|
|
12501
|
+
required: false,
|
|
12502
|
+
description: "Template ID to pre-populate fields from a template",
|
|
12503
|
+
lookupEndpoint: "/settings/templates"
|
|
11753
12504
|
},
|
|
11754
12505
|
{
|
|
11755
|
-
name: "
|
|
11756
|
-
cliName: "
|
|
11757
|
-
optionKey: "
|
|
12506
|
+
name: "subject",
|
|
12507
|
+
cliName: "subject",
|
|
12508
|
+
optionKey: "subject",
|
|
11758
12509
|
source: "body",
|
|
11759
|
-
type: "
|
|
11760
|
-
required:
|
|
11761
|
-
description: ""
|
|
12510
|
+
type: "string",
|
|
12511
|
+
required: false,
|
|
12512
|
+
description: "Email subject line"
|
|
12513
|
+
},
|
|
12514
|
+
{
|
|
12515
|
+
name: "body",
|
|
12516
|
+
cliName: "body",
|
|
12517
|
+
optionKey: "body",
|
|
12518
|
+
source: "body",
|
|
12519
|
+
type: "string",
|
|
12520
|
+
required: false,
|
|
12521
|
+
description: "Message body content (HTML supported for email)"
|
|
12522
|
+
},
|
|
12523
|
+
{
|
|
12524
|
+
name: "to",
|
|
12525
|
+
cliName: "to",
|
|
12526
|
+
optionKey: "to",
|
|
12527
|
+
source: "body",
|
|
12528
|
+
type: "array",
|
|
12529
|
+
required: false,
|
|
12530
|
+
description: "Recipients"
|
|
12531
|
+
},
|
|
12532
|
+
{
|
|
12533
|
+
name: "cc",
|
|
12534
|
+
cliName: "cc",
|
|
12535
|
+
optionKey: "cc",
|
|
12536
|
+
source: "body",
|
|
12537
|
+
type: "array",
|
|
12538
|
+
required: false,
|
|
12539
|
+
description: "CC recipients"
|
|
12540
|
+
},
|
|
12541
|
+
{
|
|
12542
|
+
name: "bcc",
|
|
12543
|
+
cliName: "bcc",
|
|
12544
|
+
optionKey: "bcc",
|
|
12545
|
+
source: "body",
|
|
12546
|
+
type: "array",
|
|
12547
|
+
required: false,
|
|
12548
|
+
description: "BCC recipients"
|
|
12549
|
+
},
|
|
12550
|
+
{
|
|
12551
|
+
name: "labelIds",
|
|
12552
|
+
cliName: "label-ids",
|
|
12553
|
+
optionKey: "labelIds",
|
|
12554
|
+
source: "body",
|
|
12555
|
+
type: "array",
|
|
12556
|
+
required: false,
|
|
12557
|
+
description: 'Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")',
|
|
12558
|
+
lookupEndpoint: "/settings/tags"
|
|
12559
|
+
},
|
|
12560
|
+
{
|
|
12561
|
+
name: "attachmentIds",
|
|
12562
|
+
cliName: "attachment-ids",
|
|
12563
|
+
optionKey: "attachmentIds",
|
|
12564
|
+
source: "body",
|
|
12565
|
+
type: "array",
|
|
12566
|
+
required: false,
|
|
12567
|
+
description: 'Attachment IDs from the upload endpoint (comma-separated, e.g. "id1,id2")'
|
|
12568
|
+
},
|
|
12569
|
+
{
|
|
12570
|
+
name: "sharing",
|
|
12571
|
+
cliName: "sharing",
|
|
12572
|
+
optionKey: "sharing",
|
|
12573
|
+
source: "body",
|
|
12574
|
+
type: "object",
|
|
12575
|
+
required: false,
|
|
12576
|
+
description: "Sharing options — control visibility to customer portal and field app"
|
|
11762
12577
|
},
|
|
11763
12578
|
{
|
|
11764
12579
|
name: "raw-body",
|
|
@@ -11773,56 +12588,54 @@ Requires scope: settings:read`,
|
|
|
11773
12588
|
hasRequestBody: true,
|
|
11774
12589
|
responseFields: [
|
|
11775
12590
|
{
|
|
11776
|
-
name: "
|
|
12591
|
+
name: "id",
|
|
12592
|
+
type: "string",
|
|
12593
|
+
description: "Entity ID"
|
|
12594
|
+
},
|
|
12595
|
+
{
|
|
12596
|
+
name: "kind",
|
|
11777
12597
|
type: "string"
|
|
11778
12598
|
},
|
|
11779
12599
|
{
|
|
11780
|
-
name: "
|
|
11781
|
-
type: "
|
|
12600
|
+
name: "body",
|
|
12601
|
+
type: "string",
|
|
12602
|
+
description: "Message body content (HTML supported for email)"
|
|
11782
12603
|
},
|
|
11783
12604
|
{
|
|
11784
|
-
name: "
|
|
12605
|
+
name: "attachments",
|
|
11785
12606
|
type: "string"
|
|
11786
12607
|
},
|
|
11787
12608
|
{
|
|
11788
|
-
name: "
|
|
11789
|
-
type: "
|
|
11790
|
-
}
|
|
11791
|
-
]
|
|
11792
|
-
},
|
|
11793
|
-
{
|
|
11794
|
-
operationId: "PublicAttachmentController_download",
|
|
11795
|
-
displayName: "Download attachment",
|
|
11796
|
-
description: `Downloads an attachment by redirecting to a time-limited SAS URL.
|
|
11797
|
-
|
|
11798
|
-
**Response:**
|
|
11799
|
-
- 302 redirect to Azure Blob Storage with SAS token
|
|
11800
|
-
- Content-Disposition header set for proper filename
|
|
11801
|
-
|
|
11802
|
-
**Note:** The SAS URL expires after 20 minutes. If expired, request a new download.`,
|
|
11803
|
-
method: "GET",
|
|
11804
|
-
path: "/attachments/{encodedId}",
|
|
11805
|
-
commandPath: ["attachments", "get"],
|
|
11806
|
-
options: [
|
|
12609
|
+
name: "createdAt",
|
|
12610
|
+
type: "string"
|
|
12611
|
+
},
|
|
11807
12612
|
{
|
|
11808
|
-
name: "
|
|
11809
|
-
cliName: "encoded-id",
|
|
11810
|
-
optionKey: "encodedId",
|
|
11811
|
-
source: "path",
|
|
12613
|
+
name: "updatedAt",
|
|
11812
12614
|
type: "string",
|
|
11813
|
-
|
|
11814
|
-
|
|
12615
|
+
description: "For optimistic concurrency — update fails if entity was modified after this timestamp"
|
|
12616
|
+
},
|
|
12617
|
+
{
|
|
12618
|
+
name: "createdBy",
|
|
12619
|
+
type: "string"
|
|
12620
|
+
},
|
|
12621
|
+
{
|
|
12622
|
+
name: "labels",
|
|
12623
|
+
type: "string"
|
|
12624
|
+
},
|
|
12625
|
+
{
|
|
12626
|
+
name: "sharing",
|
|
12627
|
+
type: "string",
|
|
12628
|
+
description: "Sharing options — control visibility to customer portal and field app"
|
|
11815
12629
|
}
|
|
11816
|
-
]
|
|
11817
|
-
hasRequestBody: false
|
|
12630
|
+
]
|
|
11818
12631
|
},
|
|
11819
12632
|
{
|
|
11820
|
-
operationId: "
|
|
11821
|
-
displayName: "
|
|
11822
|
-
description: "
|
|
11823
|
-
method: "
|
|
11824
|
-
path: "/jobs/{jobId}/activities",
|
|
11825
|
-
commandPath: ["jobs", "activities", "
|
|
12633
|
+
operationId: "PublicJobActivitiesController_createSms",
|
|
12634
|
+
displayName: "Create SMS activity (Jobs)",
|
|
12635
|
+
description: "Queues an SMS: the response is the stored activity with `sendStatus` `pending`; read the activity again for `sent` or `failed`. With `templateId`, the template is rendered for the record and fills the message and recipients the body leaves out; preview the same body at `sms/preview` first.",
|
|
12636
|
+
method: "POST",
|
|
12637
|
+
path: "/jobs/{jobId}/activities/sms",
|
|
12638
|
+
commandPath: ["jobs", "activities", "sms", "create"],
|
|
11826
12639
|
options: [
|
|
11827
12640
|
{
|
|
11828
12641
|
name: "jobId",
|
|
@@ -11834,73 +12647,63 @@ Requires scope: settings:read`,
|
|
|
11834
12647
|
description: "Job ID or job number (e.g. J12345)"
|
|
11835
12648
|
},
|
|
11836
12649
|
{
|
|
11837
|
-
name: "
|
|
11838
|
-
cliName: "
|
|
11839
|
-
optionKey: "
|
|
11840
|
-
source: "
|
|
11841
|
-
type: "
|
|
12650
|
+
name: "templateId",
|
|
12651
|
+
cliName: "template-id",
|
|
12652
|
+
optionKey: "templateId",
|
|
12653
|
+
source: "body",
|
|
12654
|
+
type: "string",
|
|
11842
12655
|
required: false,
|
|
11843
|
-
description: "
|
|
12656
|
+
description: "Template ID to pre-populate fields from a template",
|
|
12657
|
+
lookupEndpoint: "/settings/templates"
|
|
11844
12658
|
},
|
|
11845
12659
|
{
|
|
11846
|
-
name: "
|
|
11847
|
-
cliName: "
|
|
11848
|
-
optionKey: "
|
|
11849
|
-
source: "
|
|
12660
|
+
name: "body",
|
|
12661
|
+
cliName: "body",
|
|
12662
|
+
optionKey: "body",
|
|
12663
|
+
source: "body",
|
|
11850
12664
|
type: "string",
|
|
11851
12665
|
required: false,
|
|
11852
|
-
description: "
|
|
12666
|
+
description: "Message body content (HTML supported for email)"
|
|
11853
12667
|
},
|
|
11854
12668
|
{
|
|
11855
|
-
name: "
|
|
11856
|
-
cliName: "
|
|
11857
|
-
optionKey: "
|
|
11858
|
-
source: "
|
|
11859
|
-
type: "
|
|
12669
|
+
name: "to",
|
|
12670
|
+
cliName: "to",
|
|
12671
|
+
optionKey: "to",
|
|
12672
|
+
source: "body",
|
|
12673
|
+
type: "array",
|
|
11860
12674
|
required: false,
|
|
11861
|
-
description: "
|
|
11862
|
-
}
|
|
11863
|
-
],
|
|
11864
|
-
hasRequestBody: false,
|
|
11865
|
-
responseFields: [
|
|
11866
|
-
{
|
|
11867
|
-
name: "items",
|
|
11868
|
-
type: "array"
|
|
12675
|
+
description: "Recipients"
|
|
11869
12676
|
},
|
|
11870
12677
|
{
|
|
11871
|
-
name: "
|
|
11872
|
-
|
|
11873
|
-
|
|
11874
|
-
|
|
11875
|
-
|
|
11876
|
-
|
|
11877
|
-
|
|
11878
|
-
|
|
11879
|
-
|
|
11880
|
-
method: "GET",
|
|
11881
|
-
path: "/jobs/{jobId}/activities/{id}",
|
|
11882
|
-
commandPath: ["jobs", "activities", "get"],
|
|
11883
|
-
options: [
|
|
12678
|
+
name: "labelIds",
|
|
12679
|
+
cliName: "label-ids",
|
|
12680
|
+
optionKey: "labelIds",
|
|
12681
|
+
source: "body",
|
|
12682
|
+
type: "array",
|
|
12683
|
+
required: false,
|
|
12684
|
+
description: 'Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")',
|
|
12685
|
+
lookupEndpoint: "/settings/tags"
|
|
12686
|
+
},
|
|
11884
12687
|
{
|
|
11885
|
-
name: "
|
|
11886
|
-
cliName: "
|
|
11887
|
-
optionKey: "
|
|
11888
|
-
source: "
|
|
11889
|
-
type: "
|
|
11890
|
-
required:
|
|
11891
|
-
description: "
|
|
12688
|
+
name: "sharing",
|
|
12689
|
+
cliName: "sharing",
|
|
12690
|
+
optionKey: "sharing",
|
|
12691
|
+
source: "body",
|
|
12692
|
+
type: "object",
|
|
12693
|
+
required: false,
|
|
12694
|
+
description: "Sharing options — control visibility to customer portal and field app"
|
|
11892
12695
|
},
|
|
11893
12696
|
{
|
|
11894
|
-
name: "
|
|
11895
|
-
cliName: "
|
|
11896
|
-
optionKey: "
|
|
11897
|
-
source: "
|
|
11898
|
-
type: "
|
|
11899
|
-
required:
|
|
11900
|
-
description: "
|
|
12697
|
+
name: "raw-body",
|
|
12698
|
+
cliName: "raw-body",
|
|
12699
|
+
optionKey: "rawBody",
|
|
12700
|
+
source: "body",
|
|
12701
|
+
type: "object",
|
|
12702
|
+
required: false,
|
|
12703
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
11901
12704
|
}
|
|
11902
12705
|
],
|
|
11903
|
-
hasRequestBody:
|
|
12706
|
+
hasRequestBody: true,
|
|
11904
12707
|
responseFields: [
|
|
11905
12708
|
{
|
|
11906
12709
|
name: "id",
|
|
@@ -11945,12 +12748,12 @@ Requires scope: settings:read`,
|
|
|
11945
12748
|
]
|
|
11946
12749
|
},
|
|
11947
12750
|
{
|
|
11948
|
-
operationId: "
|
|
11949
|
-
displayName: "
|
|
11950
|
-
description: "
|
|
11951
|
-
method: "
|
|
11952
|
-
path: "/jobs/{jobId}/activities/
|
|
11953
|
-
commandPath: ["jobs", "activities", "
|
|
12751
|
+
operationId: "PublicJobActivitiesController_previewEmail",
|
|
12752
|
+
displayName: "Preview an email activity (Jobs)",
|
|
12753
|
+
description: "Renders the email create body with the create's own template renderer and reports the subject, body, sender and recipients the send would use, the merge fields it uses and diagnostics. Nothing is saved or sent. An `error` diagnostic is exactly what the create refuses with 400; `warning`s do not block it.",
|
|
12754
|
+
method: "POST",
|
|
12755
|
+
path: "/jobs/{jobId}/activities/email/preview",
|
|
12756
|
+
commandPath: ["jobs", "activities", "preview-email"],
|
|
11954
12757
|
options: [
|
|
11955
12758
|
{
|
|
11956
12759
|
name: "jobId",
|
|
@@ -11959,36 +12762,26 @@ Requires scope: settings:read`,
|
|
|
11959
12762
|
source: "path",
|
|
11960
12763
|
type: "string",
|
|
11961
12764
|
required: true,
|
|
11962
|
-
description: "Job ID"
|
|
12765
|
+
description: "Job ID or job number (e.g. J12345)"
|
|
11963
12766
|
},
|
|
11964
12767
|
{
|
|
11965
|
-
name: "
|
|
11966
|
-
cliName: "id",
|
|
11967
|
-
optionKey: "
|
|
11968
|
-
source: "
|
|
12768
|
+
name: "templateId",
|
|
12769
|
+
cliName: "template-id",
|
|
12770
|
+
optionKey: "templateId",
|
|
12771
|
+
source: "body",
|
|
11969
12772
|
type: "string",
|
|
11970
|
-
required:
|
|
11971
|
-
description: "
|
|
11972
|
-
|
|
11973
|
-
|
|
11974
|
-
hasRequestBody: false
|
|
11975
|
-
},
|
|
11976
|
-
{
|
|
11977
|
-
operationId: "PublicJobActivitiesController_createNote",
|
|
11978
|
-
displayName: "Create note activity (Jobs)",
|
|
11979
|
-
description: "Create note activity (Jobs)",
|
|
11980
|
-
method: "POST",
|
|
11981
|
-
path: "/jobs/{jobId}/activities/note",
|
|
11982
|
-
commandPath: ["jobs", "activities", "note", "create"],
|
|
11983
|
-
options: [
|
|
12773
|
+
required: false,
|
|
12774
|
+
description: "Template ID to pre-populate fields from a template",
|
|
12775
|
+
lookupEndpoint: "/settings/templates"
|
|
12776
|
+
},
|
|
11984
12777
|
{
|
|
11985
|
-
name: "
|
|
11986
|
-
cliName: "
|
|
11987
|
-
optionKey: "
|
|
11988
|
-
source: "
|
|
12778
|
+
name: "subject",
|
|
12779
|
+
cliName: "subject",
|
|
12780
|
+
optionKey: "subject",
|
|
12781
|
+
source: "body",
|
|
11989
12782
|
type: "string",
|
|
11990
|
-
required:
|
|
11991
|
-
description: "
|
|
12783
|
+
required: false,
|
|
12784
|
+
description: "Email subject line"
|
|
11992
12785
|
},
|
|
11993
12786
|
{
|
|
11994
12787
|
name: "body",
|
|
@@ -11996,17 +12789,35 @@ Requires scope: settings:read`,
|
|
|
11996
12789
|
optionKey: "body",
|
|
11997
12790
|
source: "body",
|
|
11998
12791
|
type: "string",
|
|
11999
|
-
required:
|
|
12792
|
+
required: false,
|
|
12000
12793
|
description: "Message body content (HTML supported for email)"
|
|
12001
12794
|
},
|
|
12002
12795
|
{
|
|
12003
|
-
name: "
|
|
12004
|
-
cliName: "
|
|
12005
|
-
optionKey: "
|
|
12796
|
+
name: "to",
|
|
12797
|
+
cliName: "to",
|
|
12798
|
+
optionKey: "to",
|
|
12006
12799
|
source: "body",
|
|
12007
|
-
type: "
|
|
12800
|
+
type: "array",
|
|
12008
12801
|
required: false,
|
|
12009
|
-
description: ""
|
|
12802
|
+
description: "Recipients"
|
|
12803
|
+
},
|
|
12804
|
+
{
|
|
12805
|
+
name: "cc",
|
|
12806
|
+
cliName: "cc",
|
|
12807
|
+
optionKey: "cc",
|
|
12808
|
+
source: "body",
|
|
12809
|
+
type: "array",
|
|
12810
|
+
required: false,
|
|
12811
|
+
description: "CC recipients"
|
|
12812
|
+
},
|
|
12813
|
+
{
|
|
12814
|
+
name: "bcc",
|
|
12815
|
+
cliName: "bcc",
|
|
12816
|
+
optionKey: "bcc",
|
|
12817
|
+
source: "body",
|
|
12818
|
+
type: "array",
|
|
12819
|
+
required: false,
|
|
12820
|
+
description: "BCC recipients"
|
|
12010
12821
|
},
|
|
12011
12822
|
{
|
|
12012
12823
|
name: "labelIds",
|
|
@@ -12049,54 +12860,56 @@ Requires scope: settings:read`,
|
|
|
12049
12860
|
hasRequestBody: true,
|
|
12050
12861
|
responseFields: [
|
|
12051
12862
|
{
|
|
12052
|
-
name: "
|
|
12053
|
-
type: "string"
|
|
12054
|
-
description: "Entity ID"
|
|
12863
|
+
name: "channel",
|
|
12864
|
+
type: "string"
|
|
12055
12865
|
},
|
|
12056
12866
|
{
|
|
12057
|
-
name: "
|
|
12867
|
+
name: "template",
|
|
12058
12868
|
type: "string"
|
|
12059
12869
|
},
|
|
12060
12870
|
{
|
|
12061
|
-
name: "
|
|
12871
|
+
name: "renderedFor",
|
|
12872
|
+
type: "string"
|
|
12873
|
+
},
|
|
12874
|
+
{
|
|
12875
|
+
name: "subject",
|
|
12062
12876
|
type: "string",
|
|
12063
|
-
description: "
|
|
12877
|
+
description: "Email subject line"
|
|
12064
12878
|
},
|
|
12065
12879
|
{
|
|
12066
|
-
name: "
|
|
12067
|
-
type: "string"
|
|
12880
|
+
name: "body",
|
|
12881
|
+
type: "string",
|
|
12882
|
+
description: "Message body content (HTML supported for email)"
|
|
12068
12883
|
},
|
|
12069
12884
|
{
|
|
12070
|
-
name: "
|
|
12885
|
+
name: "from",
|
|
12071
12886
|
type: "string"
|
|
12072
12887
|
},
|
|
12073
12888
|
{
|
|
12074
|
-
name: "
|
|
12075
|
-
type: "
|
|
12076
|
-
description: "For optimistic concurrency — update fails if entity was modified after this timestamp"
|
|
12889
|
+
name: "recipients",
|
|
12890
|
+
type: "object"
|
|
12077
12891
|
},
|
|
12078
12892
|
{
|
|
12079
|
-
name: "
|
|
12080
|
-
type: "
|
|
12893
|
+
name: "mergeFields",
|
|
12894
|
+
type: "array"
|
|
12081
12895
|
},
|
|
12082
12896
|
{
|
|
12083
|
-
name: "
|
|
12084
|
-
type: "
|
|
12897
|
+
name: "diagnostics",
|
|
12898
|
+
type: "array"
|
|
12085
12899
|
},
|
|
12086
12900
|
{
|
|
12087
|
-
name: "
|
|
12088
|
-
type: "
|
|
12089
|
-
description: "Sharing options — control visibility to customer portal and field app"
|
|
12901
|
+
name: "sendable",
|
|
12902
|
+
type: "boolean"
|
|
12090
12903
|
}
|
|
12091
12904
|
]
|
|
12092
12905
|
},
|
|
12093
12906
|
{
|
|
12094
|
-
operationId: "
|
|
12095
|
-
displayName: "
|
|
12096
|
-
description: "
|
|
12907
|
+
operationId: "PublicJobActivitiesController_previewSms",
|
|
12908
|
+
displayName: "Preview an SMS activity (Jobs)",
|
|
12909
|
+
description: "Renders the SMS create body with the create's own template renderer and reports the message, sender and recipients the send would use, the merge fields it uses and diagnostics. Nothing is saved or sent. An `error` diagnostic is exactly what the create refuses with 400; `warning`s do not block it.",
|
|
12097
12910
|
method: "POST",
|
|
12098
|
-
path: "/jobs/{jobId}/activities/
|
|
12099
|
-
commandPath: ["jobs", "activities", "
|
|
12911
|
+
path: "/jobs/{jobId}/activities/sms/preview",
|
|
12912
|
+
commandPath: ["jobs", "activities", "preview-sms"],
|
|
12100
12913
|
options: [
|
|
12101
12914
|
{
|
|
12102
12915
|
name: "jobId",
|
|
@@ -12105,7 +12918,7 @@ Requires scope: settings:read`,
|
|
|
12105
12918
|
source: "path",
|
|
12106
12919
|
type: "string",
|
|
12107
12920
|
required: true,
|
|
12108
|
-
description: "Job ID"
|
|
12921
|
+
description: "Job ID or job number (e.g. J12345)"
|
|
12109
12922
|
},
|
|
12110
12923
|
{
|
|
12111
12924
|
name: "templateId",
|
|
@@ -12118,49 +12931,170 @@ Requires scope: settings:read`,
|
|
|
12118
12931
|
lookupEndpoint: "/settings/templates"
|
|
12119
12932
|
},
|
|
12120
12933
|
{
|
|
12121
|
-
name: "
|
|
12122
|
-
cliName: "
|
|
12123
|
-
optionKey: "
|
|
12934
|
+
name: "body",
|
|
12935
|
+
cliName: "body",
|
|
12936
|
+
optionKey: "body",
|
|
12124
12937
|
source: "body",
|
|
12125
12938
|
type: "string",
|
|
12126
12939
|
required: false,
|
|
12940
|
+
description: "Message body content (HTML supported for email)"
|
|
12941
|
+
},
|
|
12942
|
+
{
|
|
12943
|
+
name: "to",
|
|
12944
|
+
cliName: "to",
|
|
12945
|
+
optionKey: "to",
|
|
12946
|
+
source: "body",
|
|
12947
|
+
type: "array",
|
|
12948
|
+
required: false,
|
|
12949
|
+
description: "Recipients"
|
|
12950
|
+
},
|
|
12951
|
+
{
|
|
12952
|
+
name: "labelIds",
|
|
12953
|
+
cliName: "label-ids",
|
|
12954
|
+
optionKey: "labelIds",
|
|
12955
|
+
source: "body",
|
|
12956
|
+
type: "array",
|
|
12957
|
+
required: false,
|
|
12958
|
+
description: 'Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")',
|
|
12959
|
+
lookupEndpoint: "/settings/tags"
|
|
12960
|
+
},
|
|
12961
|
+
{
|
|
12962
|
+
name: "sharing",
|
|
12963
|
+
cliName: "sharing",
|
|
12964
|
+
optionKey: "sharing",
|
|
12965
|
+
source: "body",
|
|
12966
|
+
type: "object",
|
|
12967
|
+
required: false,
|
|
12968
|
+
description: "Sharing options — control visibility to customer portal and field app"
|
|
12969
|
+
},
|
|
12970
|
+
{
|
|
12971
|
+
name: "raw-body",
|
|
12972
|
+
cliName: "raw-body",
|
|
12973
|
+
optionKey: "rawBody",
|
|
12974
|
+
source: "body",
|
|
12975
|
+
type: "object",
|
|
12976
|
+
required: false,
|
|
12977
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
12978
|
+
}
|
|
12979
|
+
],
|
|
12980
|
+
hasRequestBody: true,
|
|
12981
|
+
responseFields: [
|
|
12982
|
+
{
|
|
12983
|
+
name: "channel",
|
|
12984
|
+
type: "string"
|
|
12985
|
+
},
|
|
12986
|
+
{
|
|
12987
|
+
name: "template",
|
|
12988
|
+
type: "string"
|
|
12989
|
+
},
|
|
12990
|
+
{
|
|
12991
|
+
name: "renderedFor",
|
|
12992
|
+
type: "string"
|
|
12993
|
+
},
|
|
12994
|
+
{
|
|
12995
|
+
name: "subject",
|
|
12996
|
+
type: "string",
|
|
12127
12997
|
description: "Email subject line"
|
|
12128
12998
|
},
|
|
12129
12999
|
{
|
|
12130
13000
|
name: "body",
|
|
12131
|
-
cliName: "body",
|
|
12132
|
-
optionKey: "body",
|
|
12133
|
-
source: "body",
|
|
12134
13001
|
type: "string",
|
|
12135
|
-
required: false,
|
|
12136
13002
|
description: "Message body content (HTML supported for email)"
|
|
12137
13003
|
},
|
|
12138
13004
|
{
|
|
12139
|
-
name: "
|
|
12140
|
-
|
|
12141
|
-
|
|
13005
|
+
name: "from",
|
|
13006
|
+
type: "string"
|
|
13007
|
+
},
|
|
13008
|
+
{
|
|
13009
|
+
name: "recipients",
|
|
13010
|
+
type: "object"
|
|
13011
|
+
},
|
|
13012
|
+
{
|
|
13013
|
+
name: "mergeFields",
|
|
13014
|
+
type: "array"
|
|
13015
|
+
},
|
|
13016
|
+
{
|
|
13017
|
+
name: "diagnostics",
|
|
13018
|
+
type: "array"
|
|
13019
|
+
},
|
|
13020
|
+
{
|
|
13021
|
+
name: "sendable",
|
|
13022
|
+
type: "boolean"
|
|
13023
|
+
}
|
|
13024
|
+
]
|
|
13025
|
+
},
|
|
13026
|
+
{
|
|
13027
|
+
operationId: "PublicJobActivitiesController_createPhone",
|
|
13028
|
+
displayName: "Create phone activity (Jobs)",
|
|
13029
|
+
description: "Create phone activity (Jobs)",
|
|
13030
|
+
method: "POST",
|
|
13031
|
+
path: "/jobs/{jobId}/activities/phone",
|
|
13032
|
+
commandPath: ["jobs", "activities", "phone", "create"],
|
|
13033
|
+
options: [
|
|
13034
|
+
{
|
|
13035
|
+
name: "jobId",
|
|
13036
|
+
cliName: "job-id",
|
|
13037
|
+
optionKey: "jobId",
|
|
13038
|
+
source: "path",
|
|
13039
|
+
type: "string",
|
|
13040
|
+
required: true,
|
|
13041
|
+
description: "Job ID or job number (e.g. J12345)"
|
|
13042
|
+
},
|
|
13043
|
+
{
|
|
13044
|
+
name: "direction",
|
|
13045
|
+
cliName: "direction",
|
|
13046
|
+
optionKey: "direction",
|
|
13047
|
+
source: "body",
|
|
13048
|
+
type: "string",
|
|
13049
|
+
required: true,
|
|
13050
|
+
description: "",
|
|
13051
|
+
enumValues: ["inbound", "outbound"]
|
|
13052
|
+
},
|
|
13053
|
+
{
|
|
13054
|
+
name: "outcome",
|
|
13055
|
+
cliName: "outcome",
|
|
13056
|
+
optionKey: "outcome",
|
|
13057
|
+
source: "body",
|
|
13058
|
+
type: "string",
|
|
13059
|
+
required: true,
|
|
13060
|
+
description: "",
|
|
13061
|
+
enumValues: [
|
|
13062
|
+
"connected",
|
|
13063
|
+
"left_message",
|
|
13064
|
+
"left_voicemail",
|
|
13065
|
+
"busy",
|
|
13066
|
+
"no_answer",
|
|
13067
|
+
"wrong_number",
|
|
13068
|
+
"invalid_number"
|
|
13069
|
+
]
|
|
13070
|
+
},
|
|
13071
|
+
{
|
|
13072
|
+
name: "duration",
|
|
13073
|
+
cliName: "duration",
|
|
13074
|
+
optionKey: "duration",
|
|
12142
13075
|
source: "body",
|
|
12143
|
-
type: "
|
|
13076
|
+
type: "integer",
|
|
12144
13077
|
required: false,
|
|
12145
|
-
description: "
|
|
13078
|
+
description: ""
|
|
12146
13079
|
},
|
|
12147
13080
|
{
|
|
12148
|
-
name: "
|
|
12149
|
-
cliName: "
|
|
12150
|
-
optionKey: "
|
|
13081
|
+
name: "callDate",
|
|
13082
|
+
cliName: "call-date",
|
|
13083
|
+
optionKey: "callDate",
|
|
12151
13084
|
source: "body",
|
|
12152
|
-
type: "
|
|
12153
|
-
required:
|
|
12154
|
-
description: "
|
|
13085
|
+
type: "string",
|
|
13086
|
+
required: true,
|
|
13087
|
+
description: "call date (ISO 8601 datetime)",
|
|
13088
|
+
format: "date-time"
|
|
12155
13089
|
},
|
|
12156
13090
|
{
|
|
12157
|
-
name: "
|
|
12158
|
-
cliName: "
|
|
12159
|
-
optionKey: "
|
|
13091
|
+
name: "body",
|
|
13092
|
+
cliName: "body",
|
|
13093
|
+
optionKey: "body",
|
|
12160
13094
|
source: "body",
|
|
12161
|
-
type: "
|
|
13095
|
+
type: "string",
|
|
12162
13096
|
required: false,
|
|
12163
|
-
description: "
|
|
13097
|
+
description: "Message body content (HTML supported for email)"
|
|
12164
13098
|
},
|
|
12165
13099
|
{
|
|
12166
13100
|
name: "labelIds",
|
|
@@ -12172,15 +13106,6 @@ Requires scope: settings:read`,
|
|
|
12172
13106
|
description: 'Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")',
|
|
12173
13107
|
lookupEndpoint: "/settings/tags"
|
|
12174
13108
|
},
|
|
12175
|
-
{
|
|
12176
|
-
name: "attachmentIds",
|
|
12177
|
-
cliName: "attachment-ids",
|
|
12178
|
-
optionKey: "attachmentIds",
|
|
12179
|
-
source: "body",
|
|
12180
|
-
type: "array",
|
|
12181
|
-
required: false,
|
|
12182
|
-
description: 'Attachment IDs from the upload endpoint (comma-separated, e.g. "id1,id2")'
|
|
12183
|
-
},
|
|
12184
13109
|
{
|
|
12185
13110
|
name: "sharing",
|
|
12186
13111
|
cliName: "sharing",
|
|
@@ -12245,12 +13170,12 @@ Requires scope: settings:read`,
|
|
|
12245
13170
|
]
|
|
12246
13171
|
},
|
|
12247
13172
|
{
|
|
12248
|
-
operationId: "
|
|
12249
|
-
displayName: "Create
|
|
12250
|
-
description: "Create
|
|
13173
|
+
operationId: "PublicJobActivitiesController_createIntegration",
|
|
13174
|
+
displayName: "Create integration activity (Jobs)",
|
|
13175
|
+
description: "Create integration activity (Jobs)",
|
|
12251
13176
|
method: "POST",
|
|
12252
|
-
path: "/jobs/{jobId}/activities/
|
|
12253
|
-
commandPath: ["jobs", "activities", "
|
|
13177
|
+
path: "/jobs/{jobId}/activities/integration",
|
|
13178
|
+
commandPath: ["jobs", "activities", "integration", "create"],
|
|
12254
13179
|
options: [
|
|
12255
13180
|
{
|
|
12256
13181
|
name: "jobId",
|
|
@@ -12261,43 +13186,23 @@ Requires scope: settings:read`,
|
|
|
12261
13186
|
required: true,
|
|
12262
13187
|
description: "Job ID or job number (e.g. J12345)"
|
|
12263
13188
|
},
|
|
12264
|
-
{
|
|
12265
|
-
name: "templateId",
|
|
12266
|
-
cliName: "template-id",
|
|
12267
|
-
optionKey: "templateId",
|
|
12268
|
-
source: "body",
|
|
12269
|
-
type: "string",
|
|
12270
|
-
required: false,
|
|
12271
|
-
description: "Template ID to pre-populate fields from a template",
|
|
12272
|
-
lookupEndpoint: "/settings/templates"
|
|
12273
|
-
},
|
|
12274
13189
|
{
|
|
12275
13190
|
name: "body",
|
|
12276
13191
|
cliName: "body",
|
|
12277
13192
|
optionKey: "body",
|
|
12278
13193
|
source: "body",
|
|
12279
13194
|
type: "string",
|
|
12280
|
-
required:
|
|
13195
|
+
required: true,
|
|
12281
13196
|
description: "Message body content (HTML supported for email)"
|
|
12282
13197
|
},
|
|
12283
13198
|
{
|
|
12284
|
-
name: "
|
|
12285
|
-
cliName: "
|
|
12286
|
-
optionKey: "
|
|
12287
|
-
source: "body",
|
|
12288
|
-
type: "array",
|
|
12289
|
-
required: false,
|
|
12290
|
-
description: "Recipients"
|
|
12291
|
-
},
|
|
12292
|
-
{
|
|
12293
|
-
name: "labelIds",
|
|
12294
|
-
cliName: "label-ids",
|
|
12295
|
-
optionKey: "labelIds",
|
|
13199
|
+
name: "integrationType",
|
|
13200
|
+
cliName: "integration-type",
|
|
13201
|
+
optionKey: "integrationType",
|
|
12296
13202
|
source: "body",
|
|
12297
|
-
type: "
|
|
12298
|
-
required:
|
|
12299
|
-
description:
|
|
12300
|
-
lookupEndpoint: "/settings/tags"
|
|
13203
|
+
type: "string",
|
|
13204
|
+
required: true,
|
|
13205
|
+
description: ""
|
|
12301
13206
|
},
|
|
12302
13207
|
{
|
|
12303
13208
|
name: "sharing",
|
|
@@ -12363,12 +13268,12 @@ Requires scope: settings:read`,
|
|
|
12363
13268
|
]
|
|
12364
13269
|
},
|
|
12365
13270
|
{
|
|
12366
|
-
operationId: "
|
|
12367
|
-
displayName: "Create
|
|
12368
|
-
description: "Create
|
|
13271
|
+
operationId: "PublicJobActivitiesController_createThread",
|
|
13272
|
+
displayName: "Create thread activity (Jobs)",
|
|
13273
|
+
description: "Create thread activity (Jobs)",
|
|
12369
13274
|
method: "POST",
|
|
12370
|
-
path: "/jobs/{jobId}/activities/
|
|
12371
|
-
commandPath: ["jobs", "activities", "
|
|
13275
|
+
path: "/jobs/{jobId}/activities/thread",
|
|
13276
|
+
commandPath: ["jobs", "activities", "thread", "create"],
|
|
12372
13277
|
options: [
|
|
12373
13278
|
{
|
|
12374
13279
|
name: "jobId",
|
|
@@ -12379,71 +13284,23 @@ Requires scope: settings:read`,
|
|
|
12379
13284
|
required: true,
|
|
12380
13285
|
description: "Job ID or job number (e.g. J12345)"
|
|
12381
13286
|
},
|
|
12382
|
-
{
|
|
12383
|
-
name: "direction",
|
|
12384
|
-
cliName: "direction",
|
|
12385
|
-
optionKey: "direction",
|
|
12386
|
-
source: "body",
|
|
12387
|
-
type: "string",
|
|
12388
|
-
required: true,
|
|
12389
|
-
description: "",
|
|
12390
|
-
enumValues: ["inbound", "outbound"]
|
|
12391
|
-
},
|
|
12392
|
-
{
|
|
12393
|
-
name: "outcome",
|
|
12394
|
-
cliName: "outcome",
|
|
12395
|
-
optionKey: "outcome",
|
|
12396
|
-
source: "body",
|
|
12397
|
-
type: "string",
|
|
12398
|
-
required: true,
|
|
12399
|
-
description: "",
|
|
12400
|
-
enumValues: [
|
|
12401
|
-
"connected",
|
|
12402
|
-
"left_message",
|
|
12403
|
-
"left_voicemail",
|
|
12404
|
-
"busy",
|
|
12405
|
-
"no_answer",
|
|
12406
|
-
"wrong_number",
|
|
12407
|
-
"invalid_number"
|
|
12408
|
-
]
|
|
12409
|
-
},
|
|
12410
|
-
{
|
|
12411
|
-
name: "duration",
|
|
12412
|
-
cliName: "duration",
|
|
12413
|
-
optionKey: "duration",
|
|
12414
|
-
source: "body",
|
|
12415
|
-
type: "integer",
|
|
12416
|
-
required: false,
|
|
12417
|
-
description: ""
|
|
12418
|
-
},
|
|
12419
|
-
{
|
|
12420
|
-
name: "callDate",
|
|
12421
|
-
cliName: "call-date",
|
|
12422
|
-
optionKey: "callDate",
|
|
12423
|
-
source: "body",
|
|
12424
|
-
type: "string",
|
|
12425
|
-
required: true,
|
|
12426
|
-
description: "call date (ISO 8601 datetime)",
|
|
12427
|
-
format: "date-time"
|
|
12428
|
-
},
|
|
12429
13287
|
{
|
|
12430
13288
|
name: "body",
|
|
12431
13289
|
cliName: "body",
|
|
12432
13290
|
optionKey: "body",
|
|
12433
13291
|
source: "body",
|
|
12434
13292
|
type: "string",
|
|
12435
|
-
required:
|
|
13293
|
+
required: true,
|
|
12436
13294
|
description: "Message body content (HTML supported for email)"
|
|
12437
13295
|
},
|
|
12438
13296
|
{
|
|
12439
|
-
name: "
|
|
12440
|
-
cliName: "
|
|
12441
|
-
optionKey: "
|
|
13297
|
+
name: "threadType",
|
|
13298
|
+
cliName: "thread-type",
|
|
13299
|
+
optionKey: "threadType",
|
|
12442
13300
|
source: "body",
|
|
12443
|
-
type: "
|
|
12444
|
-
required:
|
|
12445
|
-
description:
|
|
12446
|
-
lookupEndpoint: "/settings/tags"
|
|
13301
|
+
type: "string",
|
|
13302
|
+
required: true,
|
|
13303
|
+
description: ""
|
|
12447
13304
|
},
|
|
12448
13305
|
{
|
|
12449
13306
|
name: "sharing",
|
|
@@ -12481,88 +13338,216 @@ Requires scope: settings:read`,
|
|
|
12481
13338
|
description: "Message body content (HTML supported for email)"
|
|
12482
13339
|
},
|
|
12483
13340
|
{
|
|
12484
|
-
name: "attachments",
|
|
12485
|
-
type: "string"
|
|
13341
|
+
name: "attachments",
|
|
13342
|
+
type: "string"
|
|
13343
|
+
},
|
|
13344
|
+
{
|
|
13345
|
+
name: "createdAt",
|
|
13346
|
+
type: "string"
|
|
13347
|
+
},
|
|
13348
|
+
{
|
|
13349
|
+
name: "updatedAt",
|
|
13350
|
+
type: "string",
|
|
13351
|
+
description: "For optimistic concurrency — update fails if entity was modified after this timestamp"
|
|
13352
|
+
},
|
|
13353
|
+
{
|
|
13354
|
+
name: "createdBy",
|
|
13355
|
+
type: "string"
|
|
13356
|
+
},
|
|
13357
|
+
{
|
|
13358
|
+
name: "labels",
|
|
13359
|
+
type: "string"
|
|
13360
|
+
},
|
|
13361
|
+
{
|
|
13362
|
+
name: "sharing",
|
|
13363
|
+
type: "string",
|
|
13364
|
+
description: "Sharing options — control visibility to customer portal and field app"
|
|
13365
|
+
}
|
|
13366
|
+
]
|
|
13367
|
+
},
|
|
13368
|
+
{
|
|
13369
|
+
operationId: "PublicStageActivitiesController_list",
|
|
13370
|
+
displayName: "List activities (Stages)",
|
|
13371
|
+
description: "List activities (Stages)",
|
|
13372
|
+
method: "GET",
|
|
13373
|
+
path: "/jobs/{jobId}/stages/{stageId}/activities",
|
|
13374
|
+
commandPath: ["stages", "activities", "list"],
|
|
13375
|
+
options: [
|
|
13376
|
+
{
|
|
13377
|
+
name: "stageId",
|
|
13378
|
+
cliName: "stage-id",
|
|
13379
|
+
optionKey: "stageId",
|
|
13380
|
+
source: "path",
|
|
13381
|
+
type: "string",
|
|
13382
|
+
required: true,
|
|
13383
|
+
description: "Stage ID or stage number"
|
|
13384
|
+
},
|
|
13385
|
+
{
|
|
13386
|
+
name: "jobId",
|
|
13387
|
+
cliName: "job-id",
|
|
13388
|
+
optionKey: "jobId",
|
|
13389
|
+
source: "path",
|
|
13390
|
+
type: "string",
|
|
13391
|
+
required: true,
|
|
13392
|
+
description: ""
|
|
13393
|
+
},
|
|
13394
|
+
{
|
|
13395
|
+
name: "kind",
|
|
13396
|
+
cliName: "kind",
|
|
13397
|
+
optionKey: "kind",
|
|
13398
|
+
source: "query",
|
|
13399
|
+
type: "array",
|
|
13400
|
+
required: false,
|
|
13401
|
+
description: "Filter by kind (repeat for multiple kinds)"
|
|
13402
|
+
},
|
|
13403
|
+
{
|
|
13404
|
+
name: "cursor",
|
|
13405
|
+
cliName: "cursor",
|
|
13406
|
+
optionKey: "cursor",
|
|
13407
|
+
source: "query",
|
|
13408
|
+
type: "string",
|
|
13409
|
+
required: false,
|
|
13410
|
+
description: "Pagination cursor from previous response"
|
|
13411
|
+
},
|
|
13412
|
+
{
|
|
13413
|
+
name: "limit",
|
|
13414
|
+
cliName: "limit",
|
|
13415
|
+
optionKey: "limit",
|
|
13416
|
+
source: "query",
|
|
13417
|
+
type: "number",
|
|
13418
|
+
required: false,
|
|
13419
|
+
description: "Maximum results to return (1-200)"
|
|
13420
|
+
}
|
|
13421
|
+
],
|
|
13422
|
+
hasRequestBody: false,
|
|
13423
|
+
responseFields: [
|
|
13424
|
+
{
|
|
13425
|
+
name: "items",
|
|
13426
|
+
type: "array"
|
|
13427
|
+
},
|
|
13428
|
+
{
|
|
13429
|
+
name: "pagination",
|
|
13430
|
+
type: "object"
|
|
13431
|
+
}
|
|
13432
|
+
]
|
|
13433
|
+
},
|
|
13434
|
+
{
|
|
13435
|
+
operationId: "PublicStageActivitiesController_listTemplates",
|
|
13436
|
+
displayName: "List email or SMS templates for this record (Stages)",
|
|
13437
|
+
description: "Published templates of the channel this record may send: its own entity's (and, on a stage, the job's), narrowed by each template's company, job type and work category scope exactly as the send applies it. Pass an `id` as `templateId` to the email or SMS create or preview.",
|
|
13438
|
+
method: "GET",
|
|
13439
|
+
path: "/jobs/{jobId}/stages/{stageId}/activities/templates",
|
|
13440
|
+
commandPath: ["stages", "activities", "templates", "list"],
|
|
13441
|
+
options: [
|
|
13442
|
+
{
|
|
13443
|
+
name: "stageId",
|
|
13444
|
+
cliName: "stage-id",
|
|
13445
|
+
optionKey: "stageId",
|
|
13446
|
+
source: "path",
|
|
13447
|
+
type: "string",
|
|
13448
|
+
required: true,
|
|
13449
|
+
description: "Stage ID or stage number"
|
|
12486
13450
|
},
|
|
12487
13451
|
{
|
|
12488
|
-
name: "
|
|
12489
|
-
|
|
13452
|
+
name: "jobId",
|
|
13453
|
+
cliName: "job-id",
|
|
13454
|
+
optionKey: "jobId",
|
|
13455
|
+
source: "path",
|
|
13456
|
+
type: "string",
|
|
13457
|
+
required: true,
|
|
13458
|
+
description: ""
|
|
12490
13459
|
},
|
|
12491
13460
|
{
|
|
12492
|
-
name: "
|
|
13461
|
+
name: "channel",
|
|
13462
|
+
cliName: "channel",
|
|
13463
|
+
optionKey: "channel",
|
|
13464
|
+
source: "query",
|
|
12493
13465
|
type: "string",
|
|
12494
|
-
|
|
12495
|
-
|
|
13466
|
+
required: true,
|
|
13467
|
+
description: "Message channel",
|
|
13468
|
+
enumValues: ["email", "sms"]
|
|
13469
|
+
}
|
|
13470
|
+
],
|
|
13471
|
+
hasRequestBody: false,
|
|
13472
|
+
responseFields: [
|
|
12496
13473
|
{
|
|
12497
|
-
name: "
|
|
12498
|
-
type: "
|
|
12499
|
-
}
|
|
13474
|
+
name: "items",
|
|
13475
|
+
type: "array"
|
|
13476
|
+
}
|
|
13477
|
+
]
|
|
13478
|
+
},
|
|
13479
|
+
{
|
|
13480
|
+
operationId: "PublicStageActivitiesController_listMergeFields",
|
|
13481
|
+
displayName: "List merge fields for this record's templates (Stages)",
|
|
13482
|
+
description: 'The merge fields this record\'s email and SMS templates may use, custom fields included, with keys as templates name them (`<span data-wb-merge="job.jobNumber">` or `{{job.jobNumber}}`).',
|
|
13483
|
+
method: "GET",
|
|
13484
|
+
path: "/jobs/{jobId}/stages/{stageId}/activities/merge-fields",
|
|
13485
|
+
commandPath: ["stages", "activities", "merge-fields", "list"],
|
|
13486
|
+
options: [
|
|
12500
13487
|
{
|
|
12501
|
-
name: "
|
|
12502
|
-
|
|
13488
|
+
name: "stageId",
|
|
13489
|
+
cliName: "stage-id",
|
|
13490
|
+
optionKey: "stageId",
|
|
13491
|
+
source: "path",
|
|
13492
|
+
type: "string",
|
|
13493
|
+
required: true,
|
|
13494
|
+
description: "Stage ID or stage number"
|
|
12503
13495
|
},
|
|
12504
13496
|
{
|
|
12505
|
-
name: "
|
|
13497
|
+
name: "jobId",
|
|
13498
|
+
cliName: "job-id",
|
|
13499
|
+
optionKey: "jobId",
|
|
13500
|
+
source: "path",
|
|
12506
13501
|
type: "string",
|
|
12507
|
-
|
|
13502
|
+
required: true,
|
|
13503
|
+
description: ""
|
|
13504
|
+
}
|
|
13505
|
+
],
|
|
13506
|
+
hasRequestBody: false,
|
|
13507
|
+
responseFields: [
|
|
13508
|
+
{
|
|
13509
|
+
name: "items",
|
|
13510
|
+
type: "array"
|
|
12508
13511
|
}
|
|
12509
13512
|
]
|
|
12510
13513
|
},
|
|
12511
13514
|
{
|
|
12512
|
-
operationId: "
|
|
12513
|
-
displayName: "
|
|
12514
|
-
description: "
|
|
12515
|
-
method: "
|
|
12516
|
-
path: "/jobs/{jobId}/activities/
|
|
12517
|
-
commandPath: ["
|
|
13515
|
+
operationId: "PublicStageActivitiesController_getById",
|
|
13516
|
+
displayName: "Get activity by ID (Stages)",
|
|
13517
|
+
description: "Get activity by ID (Stages)",
|
|
13518
|
+
method: "GET",
|
|
13519
|
+
path: "/jobs/{jobId}/stages/{stageId}/activities/{id}",
|
|
13520
|
+
commandPath: ["stages", "activities", "get"],
|
|
12518
13521
|
options: [
|
|
12519
13522
|
{
|
|
12520
|
-
name: "
|
|
12521
|
-
cliName: "
|
|
12522
|
-
optionKey: "
|
|
13523
|
+
name: "stageId",
|
|
13524
|
+
cliName: "stage-id",
|
|
13525
|
+
optionKey: "stageId",
|
|
12523
13526
|
source: "path",
|
|
12524
13527
|
type: "string",
|
|
12525
13528
|
required: true,
|
|
12526
|
-
description: "
|
|
13529
|
+
description: "Stage ID or stage number"
|
|
12527
13530
|
},
|
|
12528
13531
|
{
|
|
12529
|
-
name: "
|
|
12530
|
-
cliName: "
|
|
12531
|
-
optionKey: "
|
|
12532
|
-
source: "
|
|
13532
|
+
name: "id",
|
|
13533
|
+
cliName: "id",
|
|
13534
|
+
optionKey: "id",
|
|
13535
|
+
source: "path",
|
|
12533
13536
|
type: "string",
|
|
12534
13537
|
required: true,
|
|
12535
|
-
description: "
|
|
13538
|
+
description: "Activity ID"
|
|
12536
13539
|
},
|
|
12537
13540
|
{
|
|
12538
|
-
name: "
|
|
12539
|
-
cliName: "
|
|
12540
|
-
optionKey: "
|
|
12541
|
-
source: "
|
|
13541
|
+
name: "jobId",
|
|
13542
|
+
cliName: "job-id",
|
|
13543
|
+
optionKey: "jobId",
|
|
13544
|
+
source: "path",
|
|
12542
13545
|
type: "string",
|
|
12543
13546
|
required: true,
|
|
12544
13547
|
description: ""
|
|
12545
|
-
},
|
|
12546
|
-
{
|
|
12547
|
-
name: "sharing",
|
|
12548
|
-
cliName: "sharing",
|
|
12549
|
-
optionKey: "sharing",
|
|
12550
|
-
source: "body",
|
|
12551
|
-
type: "object",
|
|
12552
|
-
required: false,
|
|
12553
|
-
description: "Sharing options — control visibility to customer portal and field app"
|
|
12554
|
-
},
|
|
12555
|
-
{
|
|
12556
|
-
name: "raw-body",
|
|
12557
|
-
cliName: "raw-body",
|
|
12558
|
-
optionKey: "rawBody",
|
|
12559
|
-
source: "body",
|
|
12560
|
-
type: "object",
|
|
12561
|
-
required: false,
|
|
12562
|
-
description: "Raw request body JSON (overrides individual fields)"
|
|
12563
13548
|
}
|
|
12564
13549
|
],
|
|
12565
|
-
hasRequestBody:
|
|
13550
|
+
hasRequestBody: false,
|
|
12566
13551
|
responseFields: [
|
|
12567
13552
|
{
|
|
12568
13553
|
name: "id",
|
|
@@ -12607,13 +13592,60 @@ Requires scope: settings:read`,
|
|
|
12607
13592
|
]
|
|
12608
13593
|
},
|
|
12609
13594
|
{
|
|
12610
|
-
operationId: "
|
|
12611
|
-
displayName: "
|
|
12612
|
-
description: "
|
|
13595
|
+
operationId: "PublicStageActivitiesController_delete",
|
|
13596
|
+
displayName: "Delete activity (Stages)",
|
|
13597
|
+
description: "Delete activity (Stages)",
|
|
13598
|
+
method: "DELETE",
|
|
13599
|
+
path: "/jobs/{jobId}/stages/{stageId}/activities/{id}",
|
|
13600
|
+
commandPath: ["stages", "activities", "delete"],
|
|
13601
|
+
options: [
|
|
13602
|
+
{
|
|
13603
|
+
name: "stageId",
|
|
13604
|
+
cliName: "stage-id",
|
|
13605
|
+
optionKey: "stageId",
|
|
13606
|
+
source: "path",
|
|
13607
|
+
type: "string",
|
|
13608
|
+
required: true,
|
|
13609
|
+
description: "Stage ID or stage number"
|
|
13610
|
+
},
|
|
13611
|
+
{
|
|
13612
|
+
name: "id",
|
|
13613
|
+
cliName: "id",
|
|
13614
|
+
optionKey: "id",
|
|
13615
|
+
source: "path",
|
|
13616
|
+
type: "string",
|
|
13617
|
+
required: true,
|
|
13618
|
+
description: "Activity ID"
|
|
13619
|
+
},
|
|
13620
|
+
{
|
|
13621
|
+
name: "jobId",
|
|
13622
|
+
cliName: "job-id",
|
|
13623
|
+
optionKey: "jobId",
|
|
13624
|
+
source: "path",
|
|
13625
|
+
type: "string",
|
|
13626
|
+
required: true,
|
|
13627
|
+
description: "Job ID"
|
|
13628
|
+
}
|
|
13629
|
+
],
|
|
13630
|
+
hasRequestBody: false
|
|
13631
|
+
},
|
|
13632
|
+
{
|
|
13633
|
+
operationId: "PublicStageActivitiesController_createNote",
|
|
13634
|
+
displayName: "Create note activity (Stages)",
|
|
13635
|
+
description: "Create note activity (Stages)",
|
|
12613
13636
|
method: "POST",
|
|
12614
|
-
path: "/jobs/{jobId}/activities/
|
|
12615
|
-
commandPath: ["
|
|
13637
|
+
path: "/jobs/{jobId}/stages/{stageId}/activities/note",
|
|
13638
|
+
commandPath: ["stages", "activities", "note", "create"],
|
|
12616
13639
|
options: [
|
|
13640
|
+
{
|
|
13641
|
+
name: "stageId",
|
|
13642
|
+
cliName: "stage-id",
|
|
13643
|
+
optionKey: "stageId",
|
|
13644
|
+
source: "path",
|
|
13645
|
+
type: "string",
|
|
13646
|
+
required: true,
|
|
13647
|
+
description: "Stage ID or stage number"
|
|
13648
|
+
},
|
|
12617
13649
|
{
|
|
12618
13650
|
name: "jobId",
|
|
12619
13651
|
cliName: "job-id",
|
|
@@ -12621,7 +13653,7 @@ Requires scope: settings:read`,
|
|
|
12621
13653
|
source: "path",
|
|
12622
13654
|
type: "string",
|
|
12623
13655
|
required: true,
|
|
12624
|
-
description: "
|
|
13656
|
+
description: ""
|
|
12625
13657
|
},
|
|
12626
13658
|
{
|
|
12627
13659
|
name: "body",
|
|
@@ -12633,14 +13665,33 @@ Requires scope: settings:read`,
|
|
|
12633
13665
|
description: "Message body content (HTML supported for email)"
|
|
12634
13666
|
},
|
|
12635
13667
|
{
|
|
12636
|
-
name: "
|
|
12637
|
-
cliName: "
|
|
12638
|
-
optionKey: "
|
|
13668
|
+
name: "title",
|
|
13669
|
+
cliName: "title",
|
|
13670
|
+
optionKey: "title",
|
|
12639
13671
|
source: "body",
|
|
12640
13672
|
type: "string",
|
|
12641
|
-
required:
|
|
13673
|
+
required: false,
|
|
12642
13674
|
description: ""
|
|
12643
13675
|
},
|
|
13676
|
+
{
|
|
13677
|
+
name: "labelIds",
|
|
13678
|
+
cliName: "label-ids",
|
|
13679
|
+
optionKey: "labelIds",
|
|
13680
|
+
source: "body",
|
|
13681
|
+
type: "array",
|
|
13682
|
+
required: false,
|
|
13683
|
+
description: 'Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")',
|
|
13684
|
+
lookupEndpoint: "/settings/tags"
|
|
13685
|
+
},
|
|
13686
|
+
{
|
|
13687
|
+
name: "attachmentIds",
|
|
13688
|
+
cliName: "attachment-ids",
|
|
13689
|
+
optionKey: "attachmentIds",
|
|
13690
|
+
source: "body",
|
|
13691
|
+
type: "array",
|
|
13692
|
+
required: false,
|
|
13693
|
+
description: 'Attachment IDs from the upload endpoint (comma-separated, e.g. "id1,id2")'
|
|
13694
|
+
},
|
|
12644
13695
|
{
|
|
12645
13696
|
name: "sharing",
|
|
12646
13697
|
cliName: "sharing",
|
|
@@ -12705,12 +13756,12 @@ Requires scope: settings:read`,
|
|
|
12705
13756
|
]
|
|
12706
13757
|
},
|
|
12707
13758
|
{
|
|
12708
|
-
operationId: "
|
|
12709
|
-
displayName: "
|
|
12710
|
-
description: "
|
|
12711
|
-
method: "
|
|
12712
|
-
path: "/jobs/{jobId}/stages/{stageId}/activities",
|
|
12713
|
-
commandPath: ["stages", "activities", "
|
|
13759
|
+
operationId: "PublicStageActivitiesController_createEmail",
|
|
13760
|
+
displayName: "Create email activity (Stages)",
|
|
13761
|
+
description: "Create email activity (Stages)",
|
|
13762
|
+
method: "POST",
|
|
13763
|
+
path: "/jobs/{jobId}/stages/{stageId}/activities/email",
|
|
13764
|
+
commandPath: ["stages", "activities", "email", "create"],
|
|
12714
13765
|
options: [
|
|
12715
13766
|
{
|
|
12716
13767
|
name: "stageId",
|
|
@@ -12728,85 +13779,102 @@ Requires scope: settings:read`,
|
|
|
12728
13779
|
source: "path",
|
|
12729
13780
|
type: "string",
|
|
12730
13781
|
required: true,
|
|
12731
|
-
description: ""
|
|
13782
|
+
description: "Job ID"
|
|
13783
|
+
},
|
|
13784
|
+
{
|
|
13785
|
+
name: "templateId",
|
|
13786
|
+
cliName: "template-id",
|
|
13787
|
+
optionKey: "templateId",
|
|
13788
|
+
source: "body",
|
|
13789
|
+
type: "string",
|
|
13790
|
+
required: false,
|
|
13791
|
+
description: "Template ID to pre-populate fields from a template",
|
|
13792
|
+
lookupEndpoint: "/settings/templates"
|
|
13793
|
+
},
|
|
13794
|
+
{
|
|
13795
|
+
name: "subject",
|
|
13796
|
+
cliName: "subject",
|
|
13797
|
+
optionKey: "subject",
|
|
13798
|
+
source: "body",
|
|
13799
|
+
type: "string",
|
|
13800
|
+
required: false,
|
|
13801
|
+
description: "Email subject line"
|
|
13802
|
+
},
|
|
13803
|
+
{
|
|
13804
|
+
name: "body",
|
|
13805
|
+
cliName: "body",
|
|
13806
|
+
optionKey: "body",
|
|
13807
|
+
source: "body",
|
|
13808
|
+
type: "string",
|
|
13809
|
+
required: false,
|
|
13810
|
+
description: "Message body content (HTML supported for email)"
|
|
13811
|
+
},
|
|
13812
|
+
{
|
|
13813
|
+
name: "to",
|
|
13814
|
+
cliName: "to",
|
|
13815
|
+
optionKey: "to",
|
|
13816
|
+
source: "body",
|
|
13817
|
+
type: "array",
|
|
13818
|
+
required: false,
|
|
13819
|
+
description: "Recipients"
|
|
12732
13820
|
},
|
|
12733
13821
|
{
|
|
12734
|
-
name: "
|
|
12735
|
-
cliName: "
|
|
12736
|
-
optionKey: "
|
|
12737
|
-
source: "
|
|
13822
|
+
name: "cc",
|
|
13823
|
+
cliName: "cc",
|
|
13824
|
+
optionKey: "cc",
|
|
13825
|
+
source: "body",
|
|
12738
13826
|
type: "array",
|
|
12739
13827
|
required: false,
|
|
12740
|
-
description: "
|
|
13828
|
+
description: "CC recipients"
|
|
12741
13829
|
},
|
|
12742
13830
|
{
|
|
12743
|
-
name: "
|
|
12744
|
-
cliName: "
|
|
12745
|
-
optionKey: "
|
|
12746
|
-
source: "
|
|
12747
|
-
type: "
|
|
13831
|
+
name: "bcc",
|
|
13832
|
+
cliName: "bcc",
|
|
13833
|
+
optionKey: "bcc",
|
|
13834
|
+
source: "body",
|
|
13835
|
+
type: "array",
|
|
12748
13836
|
required: false,
|
|
12749
|
-
description: "
|
|
13837
|
+
description: "BCC recipients"
|
|
12750
13838
|
},
|
|
12751
13839
|
{
|
|
12752
|
-
name: "
|
|
12753
|
-
cliName: "
|
|
12754
|
-
optionKey: "
|
|
12755
|
-
source: "
|
|
12756
|
-
type: "
|
|
13840
|
+
name: "labelIds",
|
|
13841
|
+
cliName: "label-ids",
|
|
13842
|
+
optionKey: "labelIds",
|
|
13843
|
+
source: "body",
|
|
13844
|
+
type: "array",
|
|
12757
13845
|
required: false,
|
|
12758
|
-
description:
|
|
12759
|
-
|
|
12760
|
-
],
|
|
12761
|
-
hasRequestBody: false,
|
|
12762
|
-
responseFields: [
|
|
12763
|
-
{
|
|
12764
|
-
name: "items",
|
|
12765
|
-
type: "array"
|
|
13846
|
+
description: 'Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")',
|
|
13847
|
+
lookupEndpoint: "/settings/tags"
|
|
12766
13848
|
},
|
|
12767
13849
|
{
|
|
12768
|
-
name: "
|
|
12769
|
-
|
|
12770
|
-
|
|
12771
|
-
|
|
12772
|
-
|
|
12773
|
-
|
|
12774
|
-
|
|
12775
|
-
displayName: "Get activity by ID (Stages)",
|
|
12776
|
-
description: "Get activity by ID (Stages)",
|
|
12777
|
-
method: "GET",
|
|
12778
|
-
path: "/jobs/{jobId}/stages/{stageId}/activities/{id}",
|
|
12779
|
-
commandPath: ["stages", "activities", "get"],
|
|
12780
|
-
options: [
|
|
12781
|
-
{
|
|
12782
|
-
name: "stageId",
|
|
12783
|
-
cliName: "stage-id",
|
|
12784
|
-
optionKey: "stageId",
|
|
12785
|
-
source: "path",
|
|
12786
|
-
type: "string",
|
|
12787
|
-
required: true,
|
|
12788
|
-
description: "Stage ID or stage number"
|
|
13850
|
+
name: "attachmentIds",
|
|
13851
|
+
cliName: "attachment-ids",
|
|
13852
|
+
optionKey: "attachmentIds",
|
|
13853
|
+
source: "body",
|
|
13854
|
+
type: "array",
|
|
13855
|
+
required: false,
|
|
13856
|
+
description: 'Attachment IDs from the upload endpoint (comma-separated, e.g. "id1,id2")'
|
|
12789
13857
|
},
|
|
12790
13858
|
{
|
|
12791
|
-
name: "
|
|
12792
|
-
cliName: "
|
|
12793
|
-
optionKey: "
|
|
12794
|
-
source: "
|
|
12795
|
-
type: "
|
|
12796
|
-
required:
|
|
12797
|
-
description: "
|
|
13859
|
+
name: "sharing",
|
|
13860
|
+
cliName: "sharing",
|
|
13861
|
+
optionKey: "sharing",
|
|
13862
|
+
source: "body",
|
|
13863
|
+
type: "object",
|
|
13864
|
+
required: false,
|
|
13865
|
+
description: "Sharing options — control visibility to customer portal and field app"
|
|
12798
13866
|
},
|
|
12799
13867
|
{
|
|
12800
|
-
name: "
|
|
12801
|
-
cliName: "
|
|
12802
|
-
optionKey: "
|
|
12803
|
-
source: "
|
|
12804
|
-
type: "
|
|
12805
|
-
required:
|
|
12806
|
-
description: ""
|
|
13868
|
+
name: "raw-body",
|
|
13869
|
+
cliName: "raw-body",
|
|
13870
|
+
optionKey: "rawBody",
|
|
13871
|
+
source: "body",
|
|
13872
|
+
type: "object",
|
|
13873
|
+
required: false,
|
|
13874
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
12807
13875
|
}
|
|
12808
13876
|
],
|
|
12809
|
-
hasRequestBody:
|
|
13877
|
+
hasRequestBody: true,
|
|
12810
13878
|
responseFields: [
|
|
12811
13879
|
{
|
|
12812
13880
|
name: "id",
|
|
@@ -12851,12 +13919,12 @@ Requires scope: settings:read`,
|
|
|
12851
13919
|
]
|
|
12852
13920
|
},
|
|
12853
13921
|
{
|
|
12854
|
-
operationId: "
|
|
12855
|
-
displayName: "
|
|
12856
|
-
description: "
|
|
12857
|
-
method: "
|
|
12858
|
-
path: "/jobs/{jobId}/stages/{stageId}/activities/
|
|
12859
|
-
commandPath: ["stages", "activities", "
|
|
13922
|
+
operationId: "PublicStageActivitiesController_createSms",
|
|
13923
|
+
displayName: "Create SMS activity (Stages)",
|
|
13924
|
+
description: "Queues an SMS: the response is the stored activity with `sendStatus` `pending`; read the activity again for `sent` or `failed`. With `templateId`, the template is rendered for the record and fills the message and recipients the body leaves out; preview the same body at `sms/preview` first.",
|
|
13925
|
+
method: "POST",
|
|
13926
|
+
path: "/jobs/{jobId}/stages/{stageId}/activities/sms",
|
|
13927
|
+
commandPath: ["stages", "activities", "sms", "create"],
|
|
12860
13928
|
options: [
|
|
12861
13929
|
{
|
|
12862
13930
|
name: "stageId",
|
|
@@ -12867,15 +13935,6 @@ Requires scope: settings:read`,
|
|
|
12867
13935
|
required: true,
|
|
12868
13936
|
description: "Stage ID or stage number"
|
|
12869
13937
|
},
|
|
12870
|
-
{
|
|
12871
|
-
name: "id",
|
|
12872
|
-
cliName: "id",
|
|
12873
|
-
optionKey: "id",
|
|
12874
|
-
source: "path",
|
|
12875
|
-
type: "string",
|
|
12876
|
-
required: true,
|
|
12877
|
-
description: "Activity ID"
|
|
12878
|
-
},
|
|
12879
13938
|
{
|
|
12880
13939
|
name: "jobId",
|
|
12881
13940
|
cliName: "job-id",
|
|
@@ -12883,36 +13942,17 @@ Requires scope: settings:read`,
|
|
|
12883
13942
|
source: "path",
|
|
12884
13943
|
type: "string",
|
|
12885
13944
|
required: true,
|
|
12886
|
-
description: "
|
|
12887
|
-
}
|
|
12888
|
-
],
|
|
12889
|
-
hasRequestBody: false
|
|
12890
|
-
},
|
|
12891
|
-
{
|
|
12892
|
-
operationId: "PublicStageActivitiesController_createNote",
|
|
12893
|
-
displayName: "Create note activity (Stages)",
|
|
12894
|
-
description: "Create note activity (Stages)",
|
|
12895
|
-
method: "POST",
|
|
12896
|
-
path: "/jobs/{jobId}/stages/{stageId}/activities/note",
|
|
12897
|
-
commandPath: ["stages", "activities", "note", "create"],
|
|
12898
|
-
options: [
|
|
12899
|
-
{
|
|
12900
|
-
name: "stageId",
|
|
12901
|
-
cliName: "stage-id",
|
|
12902
|
-
optionKey: "stageId",
|
|
12903
|
-
source: "path",
|
|
12904
|
-
type: "string",
|
|
12905
|
-
required: true,
|
|
12906
|
-
description: "Stage ID or stage number"
|
|
13945
|
+
description: ""
|
|
12907
13946
|
},
|
|
12908
13947
|
{
|
|
12909
|
-
name: "
|
|
12910
|
-
cliName: "
|
|
12911
|
-
optionKey: "
|
|
12912
|
-
source: "
|
|
13948
|
+
name: "templateId",
|
|
13949
|
+
cliName: "template-id",
|
|
13950
|
+
optionKey: "templateId",
|
|
13951
|
+
source: "body",
|
|
12913
13952
|
type: "string",
|
|
12914
|
-
required:
|
|
12915
|
-
description: ""
|
|
13953
|
+
required: false,
|
|
13954
|
+
description: "Template ID to pre-populate fields from a template",
|
|
13955
|
+
lookupEndpoint: "/settings/templates"
|
|
12916
13956
|
},
|
|
12917
13957
|
{
|
|
12918
13958
|
name: "body",
|
|
@@ -12920,17 +13960,17 @@ Requires scope: settings:read`,
|
|
|
12920
13960
|
optionKey: "body",
|
|
12921
13961
|
source: "body",
|
|
12922
13962
|
type: "string",
|
|
12923
|
-
required:
|
|
13963
|
+
required: false,
|
|
12924
13964
|
description: "Message body content (HTML supported for email)"
|
|
12925
13965
|
},
|
|
12926
13966
|
{
|
|
12927
|
-
name: "
|
|
12928
|
-
cliName: "
|
|
12929
|
-
optionKey: "
|
|
13967
|
+
name: "to",
|
|
13968
|
+
cliName: "to",
|
|
13969
|
+
optionKey: "to",
|
|
12930
13970
|
source: "body",
|
|
12931
|
-
type: "
|
|
13971
|
+
type: "array",
|
|
12932
13972
|
required: false,
|
|
12933
|
-
description: ""
|
|
13973
|
+
description: "Recipients"
|
|
12934
13974
|
},
|
|
12935
13975
|
{
|
|
12936
13976
|
name: "labelIds",
|
|
@@ -12942,15 +13982,6 @@ Requires scope: settings:read`,
|
|
|
12942
13982
|
description: 'Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")',
|
|
12943
13983
|
lookupEndpoint: "/settings/tags"
|
|
12944
13984
|
},
|
|
12945
|
-
{
|
|
12946
|
-
name: "attachmentIds",
|
|
12947
|
-
cliName: "attachment-ids",
|
|
12948
|
-
optionKey: "attachmentIds",
|
|
12949
|
-
source: "body",
|
|
12950
|
-
type: "array",
|
|
12951
|
-
required: false,
|
|
12952
|
-
description: 'Attachment IDs from the upload endpoint (comma-separated, e.g. "id1,id2")'
|
|
12953
|
-
},
|
|
12954
13985
|
{
|
|
12955
13986
|
name: "sharing",
|
|
12956
13987
|
cliName: "sharing",
|
|
@@ -13015,12 +14046,12 @@ Requires scope: settings:read`,
|
|
|
13015
14046
|
]
|
|
13016
14047
|
},
|
|
13017
14048
|
{
|
|
13018
|
-
operationId: "
|
|
13019
|
-
displayName: "
|
|
13020
|
-
description: "
|
|
14049
|
+
operationId: "PublicStageActivitiesController_previewEmail",
|
|
14050
|
+
displayName: "Preview an email activity (Stages)",
|
|
14051
|
+
description: "Renders the email create body with the create's own template renderer and reports the subject, body, sender and recipients the send would use, the merge fields it uses and diagnostics. Nothing is saved or sent. An `error` diagnostic is exactly what the create refuses with 400; `warning`s do not block it.",
|
|
13021
14052
|
method: "POST",
|
|
13022
|
-
path: "/jobs/{jobId}/stages/{stageId}/activities/email",
|
|
13023
|
-
commandPath: ["stages", "activities", "email"
|
|
14053
|
+
path: "/jobs/{jobId}/stages/{stageId}/activities/email/preview",
|
|
14054
|
+
commandPath: ["stages", "activities", "preview-email"],
|
|
13024
14055
|
options: [
|
|
13025
14056
|
{
|
|
13026
14057
|
name: "stageId",
|
|
@@ -13038,7 +14069,7 @@ Requires scope: settings:read`,
|
|
|
13038
14069
|
source: "path",
|
|
13039
14070
|
type: "string",
|
|
13040
14071
|
required: true,
|
|
13041
|
-
description: "
|
|
14072
|
+
description: ""
|
|
13042
14073
|
},
|
|
13043
14074
|
{
|
|
13044
14075
|
name: "templateId",
|
|
@@ -13136,54 +14167,56 @@ Requires scope: settings:read`,
|
|
|
13136
14167
|
hasRequestBody: true,
|
|
13137
14168
|
responseFields: [
|
|
13138
14169
|
{
|
|
13139
|
-
name: "
|
|
13140
|
-
type: "string"
|
|
13141
|
-
description: "Entity ID"
|
|
14170
|
+
name: "channel",
|
|
14171
|
+
type: "string"
|
|
13142
14172
|
},
|
|
13143
14173
|
{
|
|
13144
|
-
name: "
|
|
14174
|
+
name: "template",
|
|
13145
14175
|
type: "string"
|
|
13146
14176
|
},
|
|
13147
14177
|
{
|
|
13148
|
-
name: "
|
|
14178
|
+
name: "renderedFor",
|
|
14179
|
+
type: "string"
|
|
14180
|
+
},
|
|
14181
|
+
{
|
|
14182
|
+
name: "subject",
|
|
13149
14183
|
type: "string",
|
|
13150
|
-
description: "
|
|
14184
|
+
description: "Email subject line"
|
|
13151
14185
|
},
|
|
13152
14186
|
{
|
|
13153
|
-
name: "
|
|
13154
|
-
type: "string"
|
|
14187
|
+
name: "body",
|
|
14188
|
+
type: "string",
|
|
14189
|
+
description: "Message body content (HTML supported for email)"
|
|
13155
14190
|
},
|
|
13156
14191
|
{
|
|
13157
|
-
name: "
|
|
14192
|
+
name: "from",
|
|
13158
14193
|
type: "string"
|
|
13159
14194
|
},
|
|
13160
14195
|
{
|
|
13161
|
-
name: "
|
|
13162
|
-
type: "
|
|
13163
|
-
description: "For optimistic concurrency — update fails if entity was modified after this timestamp"
|
|
14196
|
+
name: "recipients",
|
|
14197
|
+
type: "object"
|
|
13164
14198
|
},
|
|
13165
14199
|
{
|
|
13166
|
-
name: "
|
|
13167
|
-
type: "
|
|
14200
|
+
name: "mergeFields",
|
|
14201
|
+
type: "array"
|
|
13168
14202
|
},
|
|
13169
14203
|
{
|
|
13170
|
-
name: "
|
|
13171
|
-
type: "
|
|
14204
|
+
name: "diagnostics",
|
|
14205
|
+
type: "array"
|
|
13172
14206
|
},
|
|
13173
14207
|
{
|
|
13174
|
-
name: "
|
|
13175
|
-
type: "
|
|
13176
|
-
description: "Sharing options — control visibility to customer portal and field app"
|
|
14208
|
+
name: "sendable",
|
|
14209
|
+
type: "boolean"
|
|
13177
14210
|
}
|
|
13178
14211
|
]
|
|
13179
14212
|
},
|
|
13180
14213
|
{
|
|
13181
|
-
operationId: "
|
|
13182
|
-
displayName: "
|
|
13183
|
-
description: "
|
|
14214
|
+
operationId: "PublicStageActivitiesController_previewSms",
|
|
14215
|
+
displayName: "Preview an SMS activity (Stages)",
|
|
14216
|
+
description: "Renders the SMS create body with the create's own template renderer and reports the message, sender and recipients the send would use, the merge fields it uses and diagnostics. Nothing is saved or sent. An `error` diagnostic is exactly what the create refuses with 400; `warning`s do not block it.",
|
|
13184
14217
|
method: "POST",
|
|
13185
|
-
path: "/jobs/{jobId}/stages/{stageId}/activities/sms",
|
|
13186
|
-
commandPath: ["stages", "activities", "sms"
|
|
14218
|
+
path: "/jobs/{jobId}/stages/{stageId}/activities/sms/preview",
|
|
14219
|
+
commandPath: ["stages", "activities", "preview-sms"],
|
|
13187
14220
|
options: [
|
|
13188
14221
|
{
|
|
13189
14222
|
name: "stageId",
|
|
@@ -13263,44 +14296,46 @@ Requires scope: settings:read`,
|
|
|
13263
14296
|
hasRequestBody: true,
|
|
13264
14297
|
responseFields: [
|
|
13265
14298
|
{
|
|
13266
|
-
name: "
|
|
13267
|
-
type: "string"
|
|
13268
|
-
description: "Entity ID"
|
|
14299
|
+
name: "channel",
|
|
14300
|
+
type: "string"
|
|
13269
14301
|
},
|
|
13270
14302
|
{
|
|
13271
|
-
name: "
|
|
14303
|
+
name: "template",
|
|
13272
14304
|
type: "string"
|
|
13273
14305
|
},
|
|
13274
14306
|
{
|
|
13275
|
-
name: "
|
|
14307
|
+
name: "renderedFor",
|
|
14308
|
+
type: "string"
|
|
14309
|
+
},
|
|
14310
|
+
{
|
|
14311
|
+
name: "subject",
|
|
13276
14312
|
type: "string",
|
|
13277
|
-
description: "
|
|
14313
|
+
description: "Email subject line"
|
|
13278
14314
|
},
|
|
13279
14315
|
{
|
|
13280
|
-
name: "
|
|
13281
|
-
type: "string"
|
|
14316
|
+
name: "body",
|
|
14317
|
+
type: "string",
|
|
14318
|
+
description: "Message body content (HTML supported for email)"
|
|
13282
14319
|
},
|
|
13283
14320
|
{
|
|
13284
|
-
name: "
|
|
14321
|
+
name: "from",
|
|
13285
14322
|
type: "string"
|
|
13286
14323
|
},
|
|
13287
14324
|
{
|
|
13288
|
-
name: "
|
|
13289
|
-
type: "
|
|
13290
|
-
description: "For optimistic concurrency — update fails if entity was modified after this timestamp"
|
|
14325
|
+
name: "recipients",
|
|
14326
|
+
type: "object"
|
|
13291
14327
|
},
|
|
13292
14328
|
{
|
|
13293
|
-
name: "
|
|
13294
|
-
type: "
|
|
14329
|
+
name: "mergeFields",
|
|
14330
|
+
type: "array"
|
|
13295
14331
|
},
|
|
13296
14332
|
{
|
|
13297
|
-
name: "
|
|
13298
|
-
type: "
|
|
14333
|
+
name: "diagnostics",
|
|
14334
|
+
type: "array"
|
|
13299
14335
|
},
|
|
13300
14336
|
{
|
|
13301
|
-
name: "
|
|
13302
|
-
type: "
|
|
13303
|
-
description: "Sharing options — control visibility to customer portal and field app"
|
|
14337
|
+
name: "sendable",
|
|
14338
|
+
type: "boolean"
|
|
13304
14339
|
}
|
|
13305
14340
|
]
|
|
13306
14341
|
},
|
|
@@ -18501,7 +19536,17 @@ Requires scope: settings:read`,
|
|
|
18501
19536
|
type: "string",
|
|
18502
19537
|
required: true,
|
|
18503
19538
|
description: "Lifecycle event being reported for the run",
|
|
18504
|
-
enumValues: [
|
|
19539
|
+
enumValues: [
|
|
19540
|
+
"message",
|
|
19541
|
+
"progress",
|
|
19542
|
+
"action_required",
|
|
19543
|
+
"action_resolved",
|
|
19544
|
+
"completed",
|
|
19545
|
+
"failed",
|
|
19546
|
+
"heartbeat",
|
|
19547
|
+
"waiting",
|
|
19548
|
+
"resume_requested"
|
|
19549
|
+
]
|
|
18505
19550
|
},
|
|
18506
19551
|
{
|
|
18507
19552
|
name: "sequence",
|