repzo 1.0.278 → 1.0.280

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/changelog.md +2 -0
  2. package/lib/index.d.ts +42 -2
  3. package/lib/index.js +97 -0
  4. package/lib/types/index.d.ts +460 -1
  5. package/package.json +1 -1
  6. package/src/index.ts +223 -0
  7. package/src/oas/calendar.yaml +329 -0
  8. package/src/oas/line-target.yaml +208 -0
  9. package/src/oas/plan.yaml +258 -0
  10. package/src/oas/target-rule.yaml +256 -0
  11. package/src/types/index.ts +619 -2
package/src/oas/line-target.yaml ADDED
@@ -0,0 +1,208 @@
1
+ openapi: 3.0.3
2
+ info:
3
+ title: Repzo API - Line Target
4
+ version: 1.0.0
5
+ description: OpenAPI specification for Repzo Line Target endpoints.
6
+ servers:
7
+ - url: https://sv.api.repzo.me
8
+ paths:
9
+ /line-target:
10
+ get:
11
+ summary: Find line targets
12
+ operationId: findLineTargets
13
+ parameters:
14
+ - in: query
15
+ name: params
16
+ schema:
17
+ type: object
18
+ description: Query parameters for filtering line targets
19
+ responses:
20
+ "200":
21
+ description: A list of line targets
22
+ content:
23
+ application/json:
24
+ schema:
25
+ $ref: "#/components/schemas/LineTargetFindResult"
26
+ post:
27
+ summary: Create a line target
28
+ operationId: createLineTarget
29
+ requestBody:
30
+ required: true
31
+ content:
32
+ application/json:
33
+ schema:
34
+ $ref: "#/components/schemas/LineTargetCreateBody"
35
+ responses:
36
+ "201":
37
+ description: Line target created
38
+ content:
39
+ application/json:
40
+ schema:
41
+ $ref: "#/components/schemas/LineTargetCreateResult"
42
+ delete:
43
+ summary: Remove many line targets matching the query
44
+ operationId: removeManyLineTargets
45
+ parameters:
46
+ - in: query
47
+ name: all
48
+ schema:
49
+ type: boolean
50
+ description: When true, deletes all line targets matching the query
51
+ responses:
52
+ "200":
53
+ description: Bulk delete result
54
+ content:
55
+ application/json:
56
+ schema:
57
+ $ref: "#/components/schemas/LineTargetRemoveResult"
58
+ /line-target/{id}:
59
+ get:
60
+ summary: Get a line target by ID
61
+ operationId: getLineTarget
62
+ parameters:
63
+ - in: path
64
+ name: id
65
+ required: true
66
+ schema:
67
+ type: string
68
+ responses:
69
+ "200":
70
+ description: Line target details
71
+ content:
72
+ application/json:
73
+ schema:
74
+ $ref: "#/components/schemas/LineTargetGetResult"
75
+ put:
76
+ summary: Update a line target
77
+ operationId: updateLineTarget
78
+ parameters:
79
+ - in: path
80
+ name: id
81
+ required: true
82
+ schema:
83
+ type: string
84
+ requestBody:
85
+ required: true
86
+ content:
87
+ application/json:
88
+ schema:
89
+ $ref: "#/components/schemas/LineTargetUpdateBody"
90
+ responses:
91
+ "200":
92
+ description: Line target updated
93
+ content:
94
+ application/json:
95
+ schema:
96
+ $ref: "#/components/schemas/LineTargetUpdateResult"
97
+ delete:
98
+ summary: Remove a line target
99
+ operationId: removeLineTarget
100
+ parameters:
101
+ - in: path
102
+ name: id
103
+ required: true
104
+ schema:
105
+ type: string
106
+ responses:
107
+ "200":
108
+ description: Line target removed
109
+ content:
110
+ application/json:
111
+ schema:
112
+ $ref: "#/components/schemas/LineTargetRemoveResult"
113
+ components:
114
+ schemas:
115
+ LineTargetUser:
116
+ type: object
117
+ properties:
118
+ _id:
119
+ type: string
120
+ name:
121
+ type: string
122
+ type:
123
+ type: string
124
+ enum: [rep, client]
125
+ rep:
126
+ type: string
127
+ client:
128
+ type: string
129
+ LineTargetFindResult:
130
+ type: object
131
+ properties:
132
+ data:
133
+ type: array
134
+ items:
135
+ $ref: "#/components/schemas/LineTarget"
136
+ meta:
137
+ type: object
138
+ LineTargetCreateBody:
139
+ type: object
140
+ required:
141
+ - line
142
+ - target
143
+ - classification
144
+ properties:
145
+ line:
146
+ type: string
147
+ target:
148
+ type: number
149
+ classification:
150
+ type: string
151
+ user:
152
+ $ref: "#/components/schemas/LineTargetUser"
153
+ LineTargetCreateResult:
154
+ type: object
155
+ properties:
156
+ data:
157
+ $ref: "#/components/schemas/LineTarget"
158
+ LineTargetGetResult:
159
+ type: object
160
+ properties:
161
+ data:
162
+ $ref: "#/components/schemas/LineTarget"
163
+ LineTargetUpdateBody:
164
+ type: object
165
+ properties:
166
+ line:
167
+ type: string
168
+ target:
169
+ type: number
170
+ classification:
171
+ type: string
172
+ user:
173
+ $ref: "#/components/schemas/LineTargetUser"
174
+ LineTargetUpdateResult:
175
+ type: object
176
+ properties:
177
+ data:
178
+ $ref: "#/components/schemas/LineTarget"
179
+ LineTargetRemoveResult:
180
+ type: object
181
+ properties:
182
+ deletedCount:
183
+ type: number
184
+ success:
185
+ type: number
186
+ LineTarget:
187
+ type: object
188
+ properties:
189
+ _id:
190
+ type: string
191
+ line:
192
+ type: string
193
+ target:
194
+ type: number
195
+ classification:
196
+ type: string
197
+ user:
198
+ $ref: "#/components/schemas/LineTargetUser"
199
+ company_namespace:
200
+ type: array
201
+ items:
202
+ type: string
203
+ createdAt:
204
+ type: string
205
+ format: date-time
206
+ updatedAt:
207
+ type: string
208
+ format: date-time
package/src/oas/plan.yaml ADDED
@@ -0,0 +1,258 @@
1
+ openapi: 3.0.3
2
+ info:
3
+ title: Repzo API - Plan
4
+ version: 1.0.0
5
+ description: OpenAPI specification for Repzo Plan endpoints.
6
+ servers:
7
+ - url: https://sv.api.repzo.me
8
+ paths:
9
+ /plan:
10
+ get:
11
+ summary: Find plans
12
+ operationId: findPlans
13
+ parameters:
14
+ - in: query
15
+ name: params
16
+ schema:
17
+ type: object
18
+ description: Query parameters for filtering plans
19
+ responses:
20
+ "200":
21
+ description: A list of plans
22
+ content:
23
+ application/json:
24
+ schema:
25
+ $ref: "#/components/schemas/PlanFindResult"
26
+ post:
27
+ summary: Create a plan
28
+ operationId: createPlan
29
+ requestBody:
30
+ required: true
31
+ content:
32
+ application/json:
33
+ schema:
34
+ $ref: "#/components/schemas/PlanCreateBody"
35
+ responses:
36
+ "201":
37
+ description: Plan created
38
+ content:
39
+ application/json:
40
+ schema:
41
+ $ref: "#/components/schemas/PlanCreateResult"
42
+ /plan/{id}:
43
+ get:
44
+ summary: Get a plan by ID
45
+ operationId: getPlan
46
+ parameters:
47
+ - in: path
48
+ name: id
49
+ required: true
50
+ schema:
51
+ type: string
52
+ responses:
53
+ "200":
54
+ description: Plan details
55
+ content:
56
+ application/json:
57
+ schema:
58
+ $ref: "#/components/schemas/PlanGetResult"
59
+ put:
60
+ summary: Update a plan
61
+ operationId: updatePlan
62
+ parameters:
63
+ - in: path
64
+ name: id
65
+ required: true
66
+ schema:
67
+ type: string
68
+ requestBody:
69
+ required: true
70
+ content:
71
+ application/json:
72
+ schema:
73
+ $ref: "#/components/schemas/PlanUpdateBody"
74
+ responses:
75
+ "200":
76
+ description: Plan updated
77
+ content:
78
+ application/json:
79
+ schema:
80
+ $ref: "#/components/schemas/PlanUpdateResult"
81
+ delete:
82
+ summary: Disable a plan
83
+ operationId: removePlan
84
+ parameters:
85
+ - in: path
86
+ name: id
87
+ required: true
88
+ schema:
89
+ type: string
90
+ responses:
91
+ "200":
92
+ description: Plan disabled
93
+ content:
94
+ application/json:
95
+ schema:
96
+ $ref: "#/components/schemas/PlanRemoveResult"
97
+ components:
98
+ schemas:
99
+ PlanEditor:
100
+ type: object
101
+ properties:
102
+ _id:
103
+ type: string
104
+ type:
105
+ type: string
106
+ enum: [admin, rep]
107
+ rep:
108
+ type: string
109
+ admin:
110
+ type: string
111
+ name:
112
+ type: string
113
+ PlanBuildListItem:
114
+ type: object
115
+ properties:
116
+ calendar:
117
+ type: string
118
+ route:
119
+ type: string
120
+ client:
121
+ type: string
122
+ note:
123
+ type: string
124
+ from:
125
+ type: string
126
+ to:
127
+ type: string
128
+ visit_reason:
129
+ type: string
130
+ visit_note:
131
+ type: string
132
+ PlanBuildEntry:
133
+ type: object
134
+ properties:
135
+ day:
136
+ type: string
137
+ description: "Date in YYYY-MM-DD format"
138
+ list:
139
+ type: array
140
+ items:
141
+ $ref: "#/components/schemas/PlanBuildListItem"
142
+ PlanFindResult:
143
+ type: object
144
+ properties:
145
+ data:
146
+ type: array
147
+ items:
148
+ $ref: "#/components/schemas/Plan"
149
+ meta:
150
+ type: object
151
+ PlanCreateBody:
152
+ type: object
153
+ required:
154
+ - name
155
+ - sync_id
156
+ properties:
157
+ name:
158
+ type: string
159
+ sync_id:
160
+ type: string
161
+ startsAt:
162
+ type: string
163
+ description: "Date in YYYY-MM-DD format"
164
+ endsAt:
165
+ type: string
166
+ description: "Date in YYYY-MM-DD format"
167
+ build:
168
+ type: array
169
+ items:
170
+ $ref: "#/components/schemas/PlanBuildEntry"
171
+ calendars:
172
+ type: array
173
+ items:
174
+ type: string
175
+ disabled:
176
+ type: boolean
177
+ builtAt:
178
+ type: number
179
+ PlanCreateResult:
180
+ type: object
181
+ properties:
182
+ data:
183
+ $ref: "#/components/schemas/Plan"
184
+ PlanGetResult:
185
+ type: object
186
+ properties:
187
+ data:
188
+ $ref: "#/components/schemas/Plan"
189
+ PlanUpdateBody:
190
+ type: object
191
+ properties:
192
+ name:
193
+ type: string
194
+ sync_id:
195
+ type: string
196
+ startsAt:
197
+ type: string
198
+ endsAt:
199
+ type: string
200
+ build:
201
+ type: array
202
+ items:
203
+ $ref: "#/components/schemas/PlanBuildEntry"
204
+ calendars:
205
+ type: array
206
+ items:
207
+ type: string
208
+ disabled:
209
+ type: boolean
210
+ builtAt:
211
+ type: number
212
+ PlanUpdateResult:
213
+ type: object
214
+ properties:
215
+ data:
216
+ $ref: "#/components/schemas/Plan"
217
+ PlanRemoveResult:
218
+ type: object
219
+ properties:
220
+ data:
221
+ $ref: "#/components/schemas/Plan"
222
+ Plan:
223
+ type: object
224
+ properties:
225
+ _id:
226
+ type: string
227
+ name:
228
+ type: string
229
+ editor:
230
+ $ref: "#/components/schemas/PlanEditor"
231
+ startsAt:
232
+ type: string
233
+ endsAt:
234
+ type: string
235
+ build:
236
+ type: array
237
+ items:
238
+ $ref: "#/components/schemas/PlanBuildEntry"
239
+ sync_id:
240
+ type: string
241
+ calendars:
242
+ type: array
243
+ items:
244
+ type: string
245
+ disabled:
246
+ type: boolean
247
+ builtAt:
248
+ type: number
249
+ company_namespace:
250
+ type: array
251
+ items:
252
+ type: string
253
+ createdAt:
254
+ type: string
255
+ format: date-time
256
+ updatedAt:
257
+ type: string
258
+ format: date-time
package/src/oas/target-rule.yaml ADDED
@@ -0,0 +1,256 @@
1
+ openapi: 3.0.3
2
+ info:
3
+ title: Repzo API - Target Rule
4
+ version: 1.0.0
5
+ description: OpenAPI specification for Repzo Target Rule (Rule) endpoints.
6
+ servers:
7
+ - url: https://sv.api.repzo.me
8
+ paths:
9
+ /target-rule:
10
+ get:
11
+ summary: Find target rules
12
+ operationId: findTargetRules
13
+ parameters:
14
+ - in: query
15
+ name: params
16
+ schema:
17
+ type: object
18
+ description: Query parameters for filtering target rules
19
+ responses:
20
+ "200":
21
+ description: A list of target rules
22
+ content:
23
+ application/json:
24
+ schema:
25
+ $ref: "#/components/schemas/TargetRuleFindResult"
26
+ post:
27
+ summary: Create a target rule
28
+ operationId: createTargetRule
29
+ requestBody:
30
+ required: true
31
+ content:
32
+ application/json:
33
+ schema:
34
+ $ref: "#/components/schemas/TargetRuleCreateBody"
35
+ responses:
36
+ "201":
37
+ description: Target rule created
38
+ content:
39
+ application/json:
40
+ schema:
41
+ $ref: "#/components/schemas/TargetRuleCreateResult"
42
+ /target-rule/{id}:
43
+ get:
44
+ summary: Get a target rule by ID
45
+ operationId: getTargetRule
46
+ parameters:
47
+ - in: path
48
+ name: id
49
+ required: true
50
+ schema:
51
+ type: string
52
+ responses:
53
+ "200":
54
+ description: Target rule details
55
+ content:
56
+ application/json:
57
+ schema:
58
+ $ref: "#/components/schemas/TargetRuleGetResult"
59
+ put:
60
+ summary: Update a target rule
61
+ operationId: updateTargetRule
62
+ parameters:
63
+ - in: path
64
+ name: id
65
+ required: true
66
+ schema:
67
+ type: string
68
+ requestBody:
69
+ required: true
70
+ content:
71
+ application/json:
72
+ schema:
73
+ $ref: "#/components/schemas/TargetRuleUpdateBody"
74
+ responses:
75
+ "200":
76
+ description: Target rule updated
77
+ content:
78
+ application/json:
79
+ schema:
80
+ $ref: "#/components/schemas/TargetRuleUpdateResult"
81
+ delete:
82
+ summary: Disable a target rule
83
+ operationId: removeTargetRule
84
+ parameters:
85
+ - in: path
86
+ name: id
87
+ required: true
88
+ schema:
89
+ type: string
90
+ responses:
91
+ "200":
92
+ description: Target rule disabled
93
+ content:
94
+ application/json:
95
+ schema:
96
+ $ref: "#/components/schemas/TargetRuleRemoveResult"
97
+ components:
98
+ schemas:
99
+ TargetRuleType:
100
+ type: string
101
+ enum:
102
+ - rep-visit
103
+ - time-clock
104
+ - rep-photo
105
+ - rep-invoice
106
+ - rep-proforma
107
+ - item-status
108
+ - rep-payment
109
+ TargetRulePeriod:
110
+ type: string
111
+ enum:
112
+ - daily
113
+ - weekly
114
+ - monthly
115
+ - quarterly
116
+ - yearly
117
+ TargetRulePoint:
118
+ type: object
119
+ properties:
120
+ ratio:
121
+ type: number
122
+ points:
123
+ type: number
124
+ TargetRuleFilterEntry:
125
+ type: object
126
+ properties:
127
+ filter:
128
+ type: string
129
+ value:
130
+ type: array
131
+ items: {}
132
+ photoCount:
133
+ type: number
134
+ TargetRuleDetails:
135
+ type: object
136
+ properties:
137
+ type:
138
+ $ref: "#/components/schemas/TargetRuleType"
139
+ filter:
140
+ type: array
141
+ items:
142
+ $ref: "#/components/schemas/TargetRuleFilterEntry"
143
+ limit:
144
+ type: number
145
+ aggregation_key:
146
+ type: string
147
+ period:
148
+ $ref: "#/components/schemas/TargetRulePeriod"
149
+ required_target:
150
+ type: object
151
+ properties:
152
+ type:
153
+ type: string
154
+ enum: [absolute, assigned_to]
155
+ value:
156
+ type: number
157
+ TargetRuleFindResult:
158
+ type: object
159
+ properties:
160
+ data:
161
+ type: array
162
+ items:
163
+ $ref: "#/components/schemas/TargetRule"
164
+ meta:
165
+ type: object
166
+ TargetRuleCreateBody:
167
+ type: object
168
+ required:
169
+ - name
170
+ - type
171
+ - details
172
+ properties:
173
+ name:
174
+ type: string
175
+ type:
176
+ $ref: "#/components/schemas/TargetRuleType"
177
+ details:
178
+ $ref: "#/components/schemas/TargetRuleDetails"
179
+ points:
180
+ type: array
181
+ items:
182
+ $ref: "#/components/schemas/TargetRulePoint"
183
+ allowOverOne:
184
+ type: boolean
185
+ targets_group:
186
+ type: string
187
+ disabled:
188
+ type: boolean
189
+ TargetRuleCreateResult:
190
+ type: object
191
+ properties:
192
+ data:
193
+ $ref: "#/components/schemas/TargetRule"
194
+ TargetRuleGetResult:
195
+ type: object
196
+ properties:
197
+ data:
198
+ $ref: "#/components/schemas/TargetRule"
199
+ TargetRuleUpdateBody:
200
+ type: object
201
+ properties:
202
+ name:
203
+ type: string
204
+ details:
205
+ $ref: "#/components/schemas/TargetRuleDetails"
206
+ points:
207
+ type: array
208
+ items:
209
+ $ref: "#/components/schemas/TargetRulePoint"
210
+ allowOverOne:
211
+ type: boolean
212
+ targets_group:
213
+ type: string
214
+ disabled:
215
+ type: boolean
216
+ TargetRuleUpdateResult:
217
+ type: object
218
+ properties:
219
+ data:
220
+ $ref: "#/components/schemas/TargetRule"
221
+ TargetRuleRemoveResult:
222
+ type: object
223
+ properties:
224
+ data:
225
+ $ref: "#/components/schemas/TargetRule"
226
+ TargetRule:
227
+ type: object
228
+ properties:
229
+ _id:
230
+ type: string
231
+ name:
232
+ type: string
233
+ type:
234
+ $ref: "#/components/schemas/TargetRuleType"
235
+ points:
236
+ type: array
237
+ items:
238
+ $ref: "#/components/schemas/TargetRulePoint"
239
+ allowOverOne:
240
+ type: boolean
241
+ targets_group:
242
+ type: string
243
+ details:
244
+ $ref: "#/components/schemas/TargetRuleDetails"
245
+ disabled:
246
+ type: boolean
247
+ company_namespace:
248
+ type: array
249
+ items:
250
+ type: string
251
+ createdAt:
252
+ type: string
253
+ format: date-time
254
+ updatedAt:
255
+ type: string
256
+ format: date-time