zup-generator 0.1.0 → 0.1.1

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 26b21bf28f2ca0c7a7725027bfedfea248115b37
4
- data.tar.gz: 4c0803eb5deae4b52dd2d926d91112d8acf3de7f
3
+ metadata.gz: 875edada0cfa702b2e6ee126f90b8f265f369838
4
+ data.tar.gz: e3480937a00603d9599af8510b470108ef4d75d8
5
5
  SHA512:
6
- metadata.gz: cfd14aa03e0756a37fa82c3c7592ae05512a959cdf96e0fdf53b227dffea8284ed76be3956e798b7256ccc535ea40063c9e13a5788ae70087abec940ffe9f7f6
7
- data.tar.gz: f112ea82f712ab685ad647686154ec32903a5d628db57d13715fa59b8e8c8cbfb4f19f80e6e12971ca5a22355eb0ccacafd4d4a764ebb8c22651a8c95397c96e
6
+ metadata.gz: 84a94aec8f676a908bea1943d32fe7d064c70f9d063a33ebca9a464f5a3ddbf9286372281279b6b50a094ef8e6df5b6023e909e8c11a8b1fb2f96db8af1afc24
7
+ data.tar.gz: 940f369639ee11b19540822c2c322dd7b8377843400adbb0a3ea6a6701ef00e5ae6e1b27a1b6c4e9278494509add580b8cd6c399e92020fa3d76f8ea317887bd
Binary file
@@ -2,7 +2,10 @@
2
2
 
3
3
  require "tty-prompt"
4
4
  require "zup/generator"
5
+ require "zup/swagger"
5
6
 
7
+ @zup = Zup::Generator.new
8
+ @swagger = Zup::Swagger.new
6
9
  @prompt = TTY::Prompt.new
7
10
 
8
11
  @header = """
@@ -27,7 +30,6 @@ def login(error = false)
27
30
  user = @prompt.ask('Qual o seu e-mail da zup?', default: ENV['USER'])
28
31
  pass = @prompt.mask("Qual sua senha?", mask: heart)
29
32
 
30
- @zup = Zup::Generator.new
31
33
  if @zup.login(user, pass)
32
34
  puts "LOGADO"
33
35
  else
@@ -81,20 +83,69 @@ def choice_action
81
83
 
82
84
  case selected
83
85
  when "Copiar para Clipboard o YAML"
84
- copy_yaml
86
+ copy_yaml
85
87
  when "Selecionar outra API"
86
- choice_api
88
+ choice_api
89
+ when "Gerar pacote de Client"
90
+ export_client
87
91
  when "Sair"
88
- sair
92
+ sair
89
93
  end
90
94
  end
91
95
 
92
96
  def copy_yaml
93
- @zup.pbcopy JSON.parse(@zup.generate_swagger(@api[:id], @version[:id]).to_json).to_yaml
97
+ @zup.pbcopy @zup.generate_swagger(@api[:id], @version[:id], "yaml")
98
+ choice_action
99
+ end
100
+
101
+ def export_client
102
+ system("clear")
103
+ puts @header
104
+
105
+ if @swagger.installed?
106
+ select_language
107
+ generate_files
108
+ else
109
+ tutorial_install_swagger
110
+ end
111
+ end
112
+
113
+ def select_language
114
+ system("clear")
115
+ puts @header
116
+
117
+ @lang = @prompt.select("Qual a linguágem do client que deseja gerar?", @swagger.languages)
118
+ end
119
+
120
+ def generate_files
121
+ system("clear")
122
+ puts @header
123
+
124
+ select_output
125
+
126
+ puts "Gerando..."
127
+
128
+ content = @zup.generate_swagger(@api[:id], @version[:id])
129
+ @swagger.generate(content, @lang, @output)
94
130
 
95
131
  choice_action
96
132
  end
97
133
 
134
+ def select_output
135
+ system("clear")
136
+ puts @header
137
+
138
+ @output = @prompt.ask('Onde deseja salvar?', default: "output/")
139
+ end
140
+
141
+ def tutorial_install_swagger
142
+ puts """
143
+
144
+ O swagger-codegen não está instalado em sua maquina.
145
+
146
+ """
147
+ end
148
+
98
149
  def sair
99
150
  system("clear")
100
151
  end
Binary file
@@ -149,7 +149,7 @@ class Zup
149
149
  return JSON.parse(response.body, :symbolize_names => true)
150
150
  end
151
151
 
152
- def generate_swagger(api_id, version_id)
152
+ def generate_swagger(api_id, version_id, extension = nil)
153
153
  api = @apis.select {|e| e[:id] == api_id}.first
154
154
  version = api[:versions].select {|e| e[:id] == version_id}.first
155
155
 
@@ -224,9 +224,13 @@ class Zup
224
224
  end
225
225
  end
226
226
 
227
- # pbcopy content.to_json
228
-
229
- return content
227
+ if extension == "json"
228
+ return content.to_json
229
+ elsif extension == "yaml"
230
+ return JSON.parse(content.to_json).to_yaml
231
+ else
232
+ return content
233
+ end
230
234
  else
231
235
  return nil
232
236
  end
@@ -1,5 +1,5 @@
1
1
  class Zup
2
2
  class Generator
3
- VERSION = "0.1.0"
3
+ VERSION = "0.1.1"
4
4
  end
5
5
  end
@@ -0,0 +1,49 @@
1
+ require 'tempfile'
2
+ require 'fileutils'
3
+ require 'open3'
4
+
5
+ class Zup
6
+ class Swagger
7
+ def installed?
8
+ begin
9
+ `swagger-codegen`
10
+ return true
11
+ rescue
12
+ return false
13
+ end
14
+ end
15
+
16
+ def languages
17
+ languages = `swagger-codegen`
18
+ languages.gsub!("Available languages: ", "").tr!("[] ", "").split(',')
19
+ end
20
+
21
+ def generate(content_yml, lang, output)
22
+ path = create_temp_file(content_yml)
23
+ makedir(output)
24
+ begin
25
+ `swagger-codegen generate -i #{path} -l #{lang} -o #{output} &> /dev/null`
26
+ return true
27
+ rescue
28
+ return false
29
+ end
30
+ remove_temp_file
31
+ end
32
+
33
+ private
34
+ def create_temp_file(content_yml)
35
+ @file = Tempfile.new(['swagger', '.yaml'])
36
+
37
+ @file.write(JSON.parse(content_yml.to_json).to_yaml)
38
+ @file.rewind
39
+ @file.close
40
+ @file.path
41
+ end
42
+ def remove_temp_file
43
+ @file.unlink
44
+ end
45
+ def makedir(output)
46
+ FileUtils.mkdir(output) if !Dir.exist?(output)
47
+ end
48
+ end
49
+ end
@@ -0,0 +1 @@
1
+ {"swagger":"2.0","info":{"title":"Titulo","description":"Desc","version":"/v1"},"basePath":"/v1","paths":{"/customers/mobiles/{completeMobileNumber}/valid":{"get":{"summary":"Customer Valid Phone Number","consumes":["application/json"],"parameters":[{"name":"completeMobileNumber","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/products/{productCode}":{"get":{"summary":"Product Info","consumes":["application/json"],"parameters":[{"name":"productCode","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/addresses/{federativeUnit}/{street}/{city}/zipcode":{"get":{"summary":"ZipCode by Address","consumes":["application/json"],"parameters":[{"name":"federativeUnit","in":"path","required":true,"type":"string"},{"name":"street","in":"path","required":true,"type":"string"},{"name":"city","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/addresses/{addressId}":{"get":{"summary":"Address By ZipCode","consumes":["application/json"],"parameters":[{"name":"addressId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/correspondents":{"get":{"summary":"Correspondent Info","consumes":["application/json"],"parameters":[],"responses":{"200":{"description":"success","schema":{}},"404":{"description":"success","schema":{}}}}},"/correspondents/banks/{bankCode}/agencys":{"get":{"summary":"Agencies by Bank","consumes":["application/json"],"parameters":[{"name":"bankCode","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/sessions":{"post":{"summary":"Login","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"login":{"type":"string"},"password":{"type":"string"}}}}],"responses":{"200":{"description":"success","schema":{}},"403":{"description":"success","schema":{}}}}},"/customers/commons":{"get":{"summary":"Common Data Customers","consumes":["application/json"],"parameters":[],"responses":{"200":{"description":"success","schema":{}}}}},"/products/{productCode}/commons":{"get":{"summary":"Common Operation Data","consumes":["application/json"],"parameters":[{"name":"productCode","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/covenants/correspondents/{correspondentCode}":{"get":{"summary":"Covenants by Correspondent","consumes":["application/json"],"parameters":[{"name":"correspondentCode","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/customers/{cpf}":{"get":{"summary":"Customer Info","consumes":["application/json"],"parameters":[{"name":"cpf","in":"path","required":true,"type":"string"},{"name":"prospectIdentifier","in":"query","description":"Identificador do prospect","type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/stores/{storeCode}":{"get":{"summary":"Store Info","consumes":["application/json"],"parameters":[{"name":"storeCode","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}},"404":{"description":"success","schema":{}}}}},"/customers/{cpf}/{take}/{skip}":{"get":{"summary":"Prospects in edition by CPF","consumes":["application/json"],"parameters":[{"name":"cpf","in":"path","required":true,"type":"string"},{"name":"take","in":"path","required":true,"type":"string"},{"name":"skip","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/simulations/products":{"post":{"summary":"Simulation by Product","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"cpf":{"type":"string"},"birthDate":{"type":"string"},"productCode":{"type":"string"},"requestedValue":{"type":"integer"},"plotValue":{"type":"integer"},"plotAmount":{"type":"integer"},"rate":{"type":"integer"},"businessUnitCode":{"type":"string"},"correspondentCode":{"type":"string"},"storeCode":{"type":"string"},"covenantCode":{"type":"string"},"institutionCode":{"type":"string"}}}}],"responses":{"200":{"description":"success","schema":{}}}}},"/documents":{"post":{"summary":"Document","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"prospectIdentifier":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"fileContent":{"type":"string"},"fileType":{"type":"string"}}}}],"responses":{"200":{"description":"success","schema":{}}}}},"/proposals":{"post":{"summary":"Finalize Proposal","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"prospectIdentifier":{"type":"string"}}}}],"responses":{"200":{"description":"success","schema":{}}}}},"/simulations":{"put":{"summary":"Simulation Data","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"cpmfValue":{"type":"integer"},"dateFirstMaturity":{"type":"string"},"interestRateMonth":{"type":"string"},"interestRateYear":{"type":"string"},"iofValue":{"type":"string"},"monthRateCet":{"type":"string"},"plotQuantity":{"type":"integer"},"plotValue":{"type":"integer"},"productCode":{"type":"string"},"prospectIdentifier":{"type":"string"},"requestValue":{"type":"string"},"tccValue":{"type":"integer"},"yearRateCet":{"type":"string"}}}}],"responses":{"200":{"description":"success","schema":{}}}}},"/customers":{"put":{"summary":"Customer","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"birthDate":{"type":"string"},"businessPhone":{"type":"string"},"communicationSMSEmail":{"type":"string"},"grossIncome":{"type":"string"},"heritageValue":{"type":"integer"},"proposalIdentifier":{"type":"string"},"mobilePhone":{"type":"string"},"motherName":{"type":"string"},"politically":{"type":"string"},"registration":{"type":"string"},"residencialPhone":{"type":"string"},"maritalStatus":{"type":"string"},"nacionalityType":{"type":"string"},"name":{"type":"string"},"naturalness":{"type":"string"},"personType":{"type":"string"},"contactPhone":{"type":"string"},"cpf":{"type":"string"},"email":{"type":"string"},"genderType":{"type":"string"},"salaryAccount":{"type":"string"},"identity":{"type":"string"},"residencialAddress":{"type":"string"}}}}],"responses":{"200":{"description":"success","schema":{}}}}},"/operation-data/accounts":{"put":{"summary":"Account Data","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"accountNumber":{"type":"string"},"accountType":{"type":"string"},"agencyNumber":{"type":"string"},"bankNumber":{"type":"string"},"digitAccountVerifier":{"type":"string"},"digitAgencyVerifier":{"type":"string"},"identifier":{"type":"string"},"covenantCode":{"type":"string"},"institutionCode":{"type":"string"},"customerPassword":{"type":"string"},"reservationCodeMargin":{"type":"string"},"formVersion":{"type":"string"},"salesCpf":{"type":"string"},"salesRegistration":{"type":"string"},"paymentForm":{"type":"string"},"recipient":{"type":"string"},"customerCpf":{"type":"string"}}}}],"responses":{"200":{"description":"success","schema":{}}}}},"/prospects":{"post":{"summary":"Prospects","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"correspondentCode":{"type":"string"},"businessUnitCode":{"type":"string"},"cpf":{"type":"string"},"storeCode":{"type":"string"},"systemTypeOriginatedProposal":{"type":"string"}}}}],"responses":{"200":{"description":"success","schema":{}}}}},"/states/{federativeUnit}/cities":{"get":{"summary":"Cities by State","consumes":["application/json"],"parameters":[{"name":"federativeUnit","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/covenants/{covenantCode}/simulations/commons":{"get":{"summary":"Common Simulation","consumes":["application/json"],"parameters":[{"name":"covenantCode","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/documents/required/products/{productCode}":{"get":{"summary":"Required Documents","consumes":["application/json"],"parameters":[{"name":"productCode","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/prospects/{prospectIdentifier}/summaries":{"get":{"summary":"Prospects Summary","consumes":["application/json"],"parameters":[{"name":"prospectIdentifier","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}},"404":{"description":"success","schema":{}}}}},"/operation-data/prospects/{prospectIdentifier}":{"delete":{"summary":"Restart Operation Data","consumes":["application/json"],"parameters":[{"name":"prospectIdentifier","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/simulations/covenants":{"put":{"summary":"Simulation by Covenant","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"registration":{"type":"string"},"prospectIdentifier":{"type":"string"},"birthDate":{"type":"string"},"covenantCode":{"type":"string"},"institutionCode":{"type":"string"},"benefitCode":{"type":"string"},"correspondentCode":{"type":"string"},"storeCode":{"type":"string"},"businessUnitCode":{"type":"string"},"cpf":{"type":"string"},"plotValue":{"type":"string"}}}}],"responses":{"200":{"description":"success","schema":{}}}}},"/products/{productCode}/parameterizations":{"get":{"summary":"Product Parameterizations","consumes":["application/json"],"parameters":[{"name":"productCode","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/proposals/{proposalIdentifier}/summaries":{"get":{"summary":"Proposals Summary","consumes":["application/json"],"parameters":[{"name":"proposalIdentifier","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"status":{"type":"integer"},"resultData":{"type":"string"},"error":{"type":"string"},"errors":{"type":"string"},"api":{"type":"string"},"apiUrl":{"type":"string"}}}}],"responses":{"200":{"description":"success"}}}},"/covenants/customers/{cpf}":{"get":{"summary":"Initial Data Simulation Covenant","consumes":["application/json"],"parameters":[{"name":"cpf","in":"path","required":true,"type":"string"},{"name":"prospectIdentifier","in":"query","description":"identificador do prospect, para quando for edição","type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}},"/proposals/status":{"put":{"summary":"Proposals Status","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"correspondentCode":{"type":"string"},"finalDate":{"type":"string"},"startDate":{"type":"string"},"actuationForm":{"type":"string"},"ordination":{"type":"integer"},"take":{"type":"integer"},"skip":{"type":"integer"},"cpf":{"type":"string"},"proposalIdentifier":{"type":"string"},"statusList":{"type":"array","items":{"type":"string"}}}}}],"responses":{"200":{"description":"success","schema":{}}}}},"/prospects/{prospectIdentifier}":{"delete":{"summary":"Cancel Prospects","consumes":["application/json"],"parameters":[{"name":"prospectIdentifier","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{}}}}}}}
@@ -0,0 +1,2289 @@
1
+ ---
2
+ :swagger: '2.0'
3
+ :info:
4
+ :title: Titulo
5
+ :description: Desc
6
+ :version: "/v1"
7
+ :basePath: "/v1"
8
+ :paths:
9
+ "/customers/mobiles/{completeMobileNumber}/valid":
10
+ get:
11
+ :summary: Customer Valid Phone Number
12
+ :consumes:
13
+ - application/json
14
+ :parameters:
15
+ - :name: completeMobileNumber
16
+ :in: path
17
+ :required: true
18
+ :schema:
19
+ :type: string
20
+ :responses:
21
+ :200:
22
+ :application/json:
23
+ :schema:
24
+ :type: object
25
+ :properties:
26
+ :status:
27
+ :type: integer
28
+ :resultData:
29
+ :type: string
30
+ :error:
31
+ :type: string
32
+ :errors:
33
+ :type: string
34
+ :api:
35
+ :type: string
36
+ :apiUrl:
37
+ :type: string
38
+ "/products/{productCode}":
39
+ get:
40
+ :summary: Product Info
41
+ :consumes:
42
+ - application/json
43
+ :parameters:
44
+ - :name: productCode
45
+ :in: path
46
+ :required: true
47
+ :schema:
48
+ :type: string
49
+ :responses:
50
+ :200:
51
+ :application/json:
52
+ :schema:
53
+ :type: object
54
+ :properties:
55
+ :status:
56
+ :type: integer
57
+ :resultData:
58
+ :type:
59
+ :type: object
60
+ :properties:
61
+ :productCode:
62
+ :type: string
63
+ :productName:
64
+ :type: string
65
+ :operationCode:
66
+ :type: integer
67
+ :operationName:
68
+ :type: string
69
+ :operationTypeCode:
70
+ :type: integer
71
+ :operationTypeName:
72
+ :type: string
73
+ :codeHiringForm:
74
+ :type: string
75
+ :descriptionHiringForm:
76
+ :type: string
77
+ :documentExtensionList:
78
+ :type: array
79
+ :covenantCode:
80
+ :type: string
81
+ :productCodeAccounting:
82
+ :type: string
83
+ :error:
84
+ :type: string
85
+ :errors:
86
+ :type: string
87
+ :api:
88
+ :type: string
89
+ :apiUrl:
90
+ :type: string
91
+ "/addresses/{federativeUnit}/{street}/{city}/zipcode":
92
+ get:
93
+ :summary: ZipCode by Address
94
+ :consumes:
95
+ - application/json
96
+ :parameters:
97
+ - :name: federativeUnit
98
+ :in: path
99
+ :required: true
100
+ :schema:
101
+ :type: string
102
+ :responses:
103
+ :200:
104
+ :application/json:
105
+ :schema:
106
+ :type: object
107
+ :properties:
108
+ :status:
109
+ :type: integer
110
+ :resultData:
111
+ :type: array
112
+ :error:
113
+ :type: string
114
+ :errors:
115
+ :type: string
116
+ :api:
117
+ :type: string
118
+ :apiUrl:
119
+ :type: string
120
+ "/addresses/{addressId}":
121
+ get:
122
+ :summary: Address By ZipCode
123
+ :consumes:
124
+ - application/json
125
+ :parameters:
126
+ - :name: addressId
127
+ :in: path
128
+ :required: true
129
+ :schema:
130
+ :type: string
131
+ :responses:
132
+ :200:
133
+ :application/json:
134
+ :schema:
135
+ :type: object
136
+ :properties:
137
+ :status:
138
+ :type: integer
139
+ :resultData:
140
+ :type: array
141
+ :error:
142
+ :type: string
143
+ :errors:
144
+ :type: string
145
+ :api:
146
+ :type: string
147
+ :apiUrl:
148
+ :type: string
149
+ "/correspondents":
150
+ get:
151
+ :summary: Correspondent Info
152
+ :consumes:
153
+ - application/json
154
+ :parameters: []
155
+ :responses:
156
+ :200:
157
+ :application/json:
158
+ :schema:
159
+ :type: object
160
+ :properties:
161
+ :status:
162
+ :type: integer
163
+ :resultData:
164
+ :type:
165
+ :type: object
166
+ :properties:
167
+ :login:
168
+ :type: string
169
+ :storeList:
170
+ :type: array
171
+ :name:
172
+ :type: string
173
+ :typeAccess:
174
+ :type: integer
175
+ :code:
176
+ :type: string
177
+ :controller:
178
+ :type: string
179
+ :validityDays:
180
+ :type: integer
181
+ :expiryDate:
182
+ :type: string
183
+ :openingHours:
184
+ :type: string
185
+ :timeFinalAccess:
186
+ :type: string
187
+ :typeSubPassword:
188
+ :type: integer
189
+ :error:
190
+ :type: string
191
+ :errors:
192
+ :type: string
193
+ :api:
194
+ :type: string
195
+ :apiUrl:
196
+ :type: string
197
+ :404:
198
+ :application/json:
199
+ :schema:
200
+ :type: object
201
+ :properties:
202
+ :status:
203
+ :type: integer
204
+ :resultData:
205
+ :type: string
206
+ :error:
207
+ :type:
208
+ :type: object
209
+ :properties:
210
+ :code:
211
+ :type: string
212
+ :description:
213
+ :type: string
214
+ :errors:
215
+ :type: string
216
+ :api:
217
+ :type: string
218
+ :apiUrl:
219
+ :type: string
220
+ "/correspondents/banks/{bankCode}/agencys":
221
+ get:
222
+ :summary: Agencies by Bank
223
+ :consumes:
224
+ - application/json
225
+ :parameters:
226
+ - :name: bankCode
227
+ :in: path
228
+ :required: true
229
+ :schema:
230
+ :type: string
231
+ :responses:
232
+ :200:
233
+ :application/json:
234
+ :schema:
235
+ :type: object
236
+ :properties:
237
+ :status:
238
+ :type: integer
239
+ :resultData:
240
+ :type: array
241
+ :error:
242
+ :type: string
243
+ :errors:
244
+ :type: string
245
+ :api:
246
+ :type: string
247
+ :apiUrl:
248
+ :type: string
249
+ "/sessions":
250
+ post:
251
+ :summary: Login
252
+ :consumes:
253
+ - application/json
254
+ :parameters:
255
+ - :content:
256
+ :application/json:
257
+ :schema:
258
+ :type: object
259
+ :properties:
260
+ :login:
261
+ :type: string
262
+ :password:
263
+ :type: string
264
+ :responses:
265
+ :200:
266
+ :application/json:
267
+ :schema:
268
+ :type: object
269
+ :properties:
270
+ :status:
271
+ :type: integer
272
+ :resultData:
273
+ :type:
274
+ :type: object
275
+ :properties:
276
+ :login:
277
+ :type: string
278
+ :permission:
279
+ :type:
280
+ :type: object
281
+ :properties:
282
+ :result:
283
+ :type: string
284
+ :hasPermission:
285
+ :type: string
286
+ :list:
287
+ :type: array
288
+ :authentication:
289
+ :type: string
290
+ :authenticationResult:
291
+ :type: string
292
+ :error:
293
+ :type: string
294
+ :errors:
295
+ :type: string
296
+ :api:
297
+ :type: string
298
+ :apiUrl:
299
+ :type: string
300
+ :403:
301
+ :application/json:
302
+ :schema:
303
+ :type: object
304
+ :properties:
305
+ :status:
306
+ :type: integer
307
+ :resultData:
308
+ :type: string
309
+ :error:
310
+ :type:
311
+ :type: object
312
+ :properties:
313
+ :code:
314
+ :type: string
315
+ :description:
316
+ :type: string
317
+ :errors:
318
+ :type: string
319
+ :api:
320
+ :type: string
321
+ :apiUrl:
322
+ :type: string
323
+ "/customers/commons":
324
+ get:
325
+ :summary: Common Data Customers
326
+ :consumes:
327
+ - application/json
328
+ :parameters: []
329
+ :responses:
330
+ :200:
331
+ :application/json:
332
+ :schema:
333
+ :type: object
334
+ :properties:
335
+ :status:
336
+ :type: integer
337
+ :resultData:
338
+ :type:
339
+ :type: object
340
+ :properties:
341
+ :maritalStatusList:
342
+ :type: array
343
+ :federativeUnitList:
344
+ :type: array
345
+ :streetTypeList:
346
+ :type: array
347
+ :error:
348
+ :type: string
349
+ :errors:
350
+ :type: string
351
+ :api:
352
+ :type: string
353
+ :apiUrl:
354
+ :type: string
355
+ "/products/{productCode}/commons":
356
+ get:
357
+ :summary: Common Operation Data
358
+ :consumes:
359
+ - application/json
360
+ :parameters:
361
+ - :name: productCode
362
+ :in: path
363
+ :required: true
364
+ :schema:
365
+ :type: string
366
+ :responses:
367
+ :200:
368
+ :application/json:
369
+ :schema:
370
+ :type: object
371
+ :properties:
372
+ :status:
373
+ :type: integer
374
+ :resultData:
375
+ :type:
376
+ :type: object
377
+ :properties:
378
+ :accountList:
379
+ :type: array
380
+ :activeBankList:
381
+ :type: array
382
+ :paymentFormList:
383
+ :type: array
384
+ :error:
385
+ :type: string
386
+ :errors:
387
+ :type: string
388
+ :api:
389
+ :type: string
390
+ :apiUrl:
391
+ :type: string
392
+ "/covenants/correspondents/{correspondentCode}":
393
+ get:
394
+ :summary: Covenants by Correspondent
395
+ :consumes:
396
+ - application/json
397
+ :parameters:
398
+ - :name: correspondentCode
399
+ :in: path
400
+ :required: true
401
+ :schema:
402
+ :type: string
403
+ :responses:
404
+ :200:
405
+ :application/json:
406
+ :schema:
407
+ :type: object
408
+ :properties:
409
+ :status:
410
+ :type: integer
411
+ :resultData:
412
+ :type: array
413
+ :error:
414
+ :type: string
415
+ :errors:
416
+ :type: string
417
+ :api:
418
+ :type: string
419
+ :apiUrl:
420
+ :type: string
421
+ "/customers/{cpf}":
422
+ get:
423
+ :summary: Customer Info
424
+ :consumes:
425
+ - application/json
426
+ :parameters:
427
+ - :name: cpf
428
+ :in: path
429
+ :required: true
430
+ :schema:
431
+ :type: string
432
+ - :name: :prospectIdentifier
433
+ :in: query
434
+ :description: Identificador do prospect
435
+ :schema:
436
+ :type: string
437
+ :responses:
438
+ :200:
439
+ :application/json:
440
+ :schema:
441
+ :type: object
442
+ :properties:
443
+ :status:
444
+ :type: integer
445
+ :resultData:
446
+ :type:
447
+ :type: object
448
+ :properties:
449
+ :cpf:
450
+ :type: string
451
+ :email:
452
+ :type: string
453
+ :identifier:
454
+ :type: string
455
+ :bankAccount:
456
+ :type:
457
+ :type: object
458
+ :properties:
459
+ :accountCode:
460
+ :type: string
461
+ :accountType:
462
+ :type: integer
463
+ :identifier:
464
+ :type: string
465
+ :digitAgencyVerifier:
466
+ :type: string
467
+ :digitAccountVerifier:
468
+ :type: string
469
+ :agencyNumber:
470
+ :type: string
471
+ :bankNumber:
472
+ :type: string
473
+ :accountNumber:
474
+ :type: string
475
+ :receivePayment:
476
+ :type: string
477
+ :identityEmissionDate:
478
+ :type: string
479
+ :birthDate:
480
+ :type: string
481
+ :businessAddress:
482
+ :type: string
483
+ :homeAddress:
484
+ :type:
485
+ :type: object
486
+ :properties:
487
+ :neighborhood:
488
+ :type: string
489
+ :zipCode:
490
+ :type: string
491
+ :city:
492
+ :type: string
493
+ :street:
494
+ :type: string
495
+ :state:
496
+ :type: string
497
+ :acronymState:
498
+ :type: string
499
+ :zipCodeType:
500
+ :type: string
501
+ :streetType:
502
+ :type: string
503
+ :addressCode:
504
+ :type: string
505
+ :identifier:
506
+ :type: string
507
+ :unitFederativeType:
508
+ :type: integer
509
+ :addressType:
510
+ :type: integer
511
+ :number:
512
+ :type: string
513
+ :complement:
514
+ :type: string
515
+ :receiveInvoice:
516
+ :type: string
517
+ :name:
518
+ :type: string
519
+ :motherName:
520
+ :type: string
521
+ :identityNumber:
522
+ :type: string
523
+ :organizationInssuingIdentity:
524
+ :type: string
525
+ :politically:
526
+ :type: string
527
+ :grossIncome:
528
+ :type: integer
529
+ :ufrgType:
530
+ :type: integer
531
+ :mobilePhone:
532
+ :type: string
533
+ :businessPhone:
534
+ :type: string
535
+ :contactPhone:
536
+ :type: string
537
+ :residencialPhone:
538
+ :type: string
539
+ :maritalStatusType:
540
+ :type: integer
541
+ :personType:
542
+ :type: integer
543
+ :genderType:
544
+ :type: integer
545
+ :heritageValue:
546
+ :type: integer
547
+ :typeNacionality:
548
+ :type: integer
549
+ :receiveSms:
550
+ :type: string
551
+ :naturalness:
552
+ :type: string
553
+ :operationData:
554
+ :type:
555
+ :type: object
556
+ :properties:
557
+ :customerPassword:
558
+ :type: string
559
+ :reservationCodeMargin:
560
+ :type: string
561
+ :error:
562
+ :type: string
563
+ :errors:
564
+ :type: string
565
+ :api:
566
+ :type: string
567
+ :apiUrl:
568
+ :type: string
569
+ "/stores/{storeCode}":
570
+ get:
571
+ :summary: Store Info
572
+ :consumes:
573
+ - application/json
574
+ :parameters:
575
+ - :name: storeCode
576
+ :in: path
577
+ :required: true
578
+ :schema:
579
+ :type: string
580
+ :responses:
581
+ :200:
582
+ :application/json:
583
+ :schema:
584
+ :type: object
585
+ :properties:
586
+ :status:
587
+ :type: integer
588
+ :resultData:
589
+ :type:
590
+ :type: object
591
+ :properties:
592
+ :correspondentCode:
593
+ :type: string
594
+ :businessUnitCode:
595
+ :type: string
596
+ :correspondentName:
597
+ :type: string
598
+ :error:
599
+ :type: string
600
+ :errors:
601
+ :type: string
602
+ :api:
603
+ :type: string
604
+ :apiUrl:
605
+ :type: string
606
+ :404:
607
+ :application/json:
608
+ :schema:
609
+ :type: object
610
+ :properties:
611
+ :status:
612
+ :type: integer
613
+ :resultData:
614
+ :type: string
615
+ :error:
616
+ :type:
617
+ :type: object
618
+ :properties:
619
+ :code:
620
+ :type: string
621
+ :description:
622
+ :type: string
623
+ :errors:
624
+ :type: string
625
+ :api:
626
+ :type: string
627
+ :apiUrl:
628
+ :type: string
629
+ "/customers/{cpf}/{take}/{skip}":
630
+ get:
631
+ :summary: Prospects in edition by CPF
632
+ :consumes:
633
+ - application/json
634
+ :parameters:
635
+ - :name: cpf
636
+ :in: path
637
+ :required: true
638
+ :schema:
639
+ :type: string
640
+ :responses:
641
+ :200:
642
+ :application/json:
643
+ :schema:
644
+ :type: object
645
+ :properties:
646
+ :status:
647
+ :type: integer
648
+ :resultData:
649
+ :type:
650
+ :type: object
651
+ :properties:
652
+ :quantityRecords:
653
+ :type: integer
654
+ :message:
655
+ :type: string
656
+ :simulationList:
657
+ :type: array
658
+ :error:
659
+ :type: string
660
+ :errors:
661
+ :type: string
662
+ :api:
663
+ :type: string
664
+ :apiUrl:
665
+ :type: string
666
+ "/simulations/products":
667
+ post:
668
+ :summary: Simulation by Product
669
+ :consumes:
670
+ - application/json
671
+ :parameters:
672
+ - :content:
673
+ :application/json:
674
+ :schema:
675
+ :type: object
676
+ :properties:
677
+ :cpf:
678
+ :type: string
679
+ :birthDate:
680
+ :type: string
681
+ :productCode:
682
+ :type: string
683
+ :requestedValue:
684
+ :type: integer
685
+ :plotValue:
686
+ :type: integer
687
+ :plotAmount:
688
+ :type: integer
689
+ :rate:
690
+ :type: integer
691
+ :businessUnitCode:
692
+ :type: string
693
+ :correspondentCode:
694
+ :type: string
695
+ :storeCode:
696
+ :type: string
697
+ :covenantCode:
698
+ :type: string
699
+ :institutionCode:
700
+ :type: string
701
+ :responses:
702
+ :200:
703
+ :application/json:
704
+ :schema:
705
+ :type: object
706
+ :properties:
707
+ :status:
708
+ :type: integer
709
+ :resultData:
710
+ :type:
711
+ :type: object
712
+ :properties:
713
+ :releaseDate:
714
+ :type: string
715
+ :plotAmount:
716
+ :type: string
717
+ :requestedValue:
718
+ :type: string
719
+ :plotValue:
720
+ :type: string
721
+ :mainValue:
722
+ :type: string
723
+ :grossValue:
724
+ :type: string
725
+ :rate:
726
+ :type: string
727
+ :cetRate:
728
+ :type: string
729
+ :firstMaturity:
730
+ :type: string
731
+ :iofValue:
732
+ :type: string
733
+ :cpmfValue:
734
+ :type: string
735
+ :tccValue:
736
+ :type: string
737
+ :error:
738
+ :type: string
739
+ :errors:
740
+ :type: string
741
+ :api:
742
+ :type: string
743
+ :apiUrl:
744
+ :type: string
745
+ "/documents":
746
+ post:
747
+ :summary: Document
748
+ :consumes:
749
+ - application/json
750
+ :parameters:
751
+ - :content:
752
+ :application/json:
753
+ :schema:
754
+ :type: object
755
+ :properties:
756
+ :prospectIdentifier:
757
+ :type: string
758
+ :name:
759
+ :type: string
760
+ :extension:
761
+ :type: string
762
+ :fileContent:
763
+ :type: string
764
+ :fileType:
765
+ :type: string
766
+ :responses:
767
+ :200:
768
+ :application/json:
769
+ :schema:
770
+ :type: object
771
+ :properties:
772
+ :status:
773
+ :type: integer
774
+ :resultData:
775
+ :type:
776
+ :type: object
777
+ :properties:
778
+ :prospectIdentifier:
779
+ :type: string
780
+ :documentIdentifier:
781
+ :type: string
782
+ :integratedGed:
783
+ :type: string
784
+ :error:
785
+ :type: string
786
+ :errors:
787
+ :type: string
788
+ :api:
789
+ :type: string
790
+ :apiUrl:
791
+ :type: string
792
+ "/proposals":
793
+ post:
794
+ :summary: Finalize Proposal
795
+ :consumes:
796
+ - application/json
797
+ :parameters:
798
+ - :content:
799
+ :application/json:
800
+ :schema:
801
+ :type: object
802
+ :properties:
803
+ :prospectIdentifier:
804
+ :type: string
805
+ :responses:
806
+ :200:
807
+ :application/json:
808
+ :schema:
809
+ :type: object
810
+ :properties:
811
+ :status:
812
+ :type: integer
813
+ :resultData:
814
+ :type:
815
+ :type: object
816
+ :properties:
817
+ :prospectIdentifier:
818
+ :type: string
819
+ :error:
820
+ :type: string
821
+ :errors:
822
+ :type: string
823
+ :api:
824
+ :type: string
825
+ :apiUrl:
826
+ :type: string
827
+ "/simulations":
828
+ put:
829
+ :summary: Simulation Data
830
+ :consumes:
831
+ - application/json
832
+ :parameters:
833
+ - :content:
834
+ :application/json:
835
+ :schema:
836
+ :type: object
837
+ :properties:
838
+ :cpmfValue:
839
+ :type: integer
840
+ :dateFirstMaturity:
841
+ :type: string
842
+ :interestRateMonth:
843
+ :type: string
844
+ :interestRateYear:
845
+ :type: string
846
+ :iofValue:
847
+ :type: string
848
+ :monthRateCet:
849
+ :type: string
850
+ :plotQuantity:
851
+ :type: integer
852
+ :plotValue:
853
+ :type: integer
854
+ :productCode:
855
+ :type: string
856
+ :prospectIdentifier:
857
+ :type: string
858
+ :requestValue:
859
+ :type: string
860
+ :tccValue:
861
+ :type: integer
862
+ :yearRateCet:
863
+ :type: string
864
+ :responses:
865
+ :200:
866
+ :application/json:
867
+ :schema:
868
+ :type: object
869
+ :properties:
870
+ :status:
871
+ :type: integer
872
+ :resultData:
873
+ :type:
874
+ :type: object
875
+ :properties:
876
+ :prospectIdentifier:
877
+ :type: string
878
+ :result:
879
+ :type: string
880
+ :error:
881
+ :type: string
882
+ :errors:
883
+ :type: string
884
+ :api:
885
+ :type: string
886
+ :apiUrl:
887
+ :type: string
888
+ "/customers":
889
+ put:
890
+ :summary: Customer
891
+ :consumes:
892
+ - application/json
893
+ :parameters:
894
+ - :content:
895
+ :application/json:
896
+ :schema:
897
+ :type: object
898
+ :properties:
899
+ :birthDate:
900
+ :type: string
901
+ :businessPhone:
902
+ :type: string
903
+ :communicationSMSEmail:
904
+ :type: string
905
+ :grossIncome:
906
+ :type: string
907
+ :heritageValue:
908
+ :type: integer
909
+ :proposalIdentifier:
910
+ :type: string
911
+ :mobilePhone:
912
+ :type: string
913
+ :motherName:
914
+ :type: string
915
+ :politically:
916
+ :type: string
917
+ :registration:
918
+ :type: string
919
+ :residencialPhone:
920
+ :type: string
921
+ :maritalStatus:
922
+ :type: string
923
+ :nacionalityType:
924
+ :type: string
925
+ :name:
926
+ :type: string
927
+ :naturalness:
928
+ :type: string
929
+ :personType:
930
+ :type: string
931
+ :contactPhone:
932
+ :type: string
933
+ :cpf:
934
+ :type: string
935
+ :email:
936
+ :type: string
937
+ :genderType:
938
+ :type: string
939
+ :salaryAccount:
940
+ :type: string
941
+ :identity:
942
+ :type:
943
+ :type: object
944
+ :properties:
945
+ :dateIssue:
946
+ :type: string
947
+ :issuingEntity:
948
+ :type: string
949
+ :number:
950
+ :type: string
951
+ :unitFederativeType:
952
+ :type: string
953
+ :residencialAddress:
954
+ :type:
955
+ :type: object
956
+ :properties:
957
+ :addressType:
958
+ :type: string
959
+ :complement:
960
+ :type: string
961
+ :number:
962
+ :type: string
963
+ :receivesInvoice:
964
+ :type: string
965
+ :unitFederativeType:
966
+ :type: string
967
+ :city:
968
+ :type: string
969
+ :neighborhood:
970
+ :type: string
971
+ :street:
972
+ :type: string
973
+ :streetType:
974
+ :type: string
975
+ :zipCode:
976
+ :type: string
977
+ :responses:
978
+ :200:
979
+ :application/json:
980
+ :schema:
981
+ :type: object
982
+ :properties:
983
+ :status:
984
+ :type: integer
985
+ :resultData:
986
+ :type:
987
+ :type: object
988
+ :properties:
989
+ :residencialAddress:
990
+ :type:
991
+ :type: object
992
+ :properties:
993
+ :identifier:
994
+ :type: string
995
+ :address:
996
+ :type:
997
+ :type: object
998
+ :properties:
999
+ :addressCode:
1000
+ :type: string
1001
+ :identifier:
1002
+ :type: string
1003
+ :zipCode:
1004
+ :type: string
1005
+ :streetType:
1006
+ :type: string
1007
+ :street:
1008
+ :type: string
1009
+ :number:
1010
+ :type: string
1011
+ :complement:
1012
+ :type: string
1013
+ :neighborhood:
1014
+ :type: string
1015
+ :city:
1016
+ :type: string
1017
+ :unitFederativeType:
1018
+ :type: string
1019
+ :addressType:
1020
+ :type: string
1021
+ :receivesInvoice:
1022
+ :type: string
1023
+ :identifier:
1024
+ :type: string
1025
+ :registration:
1026
+ :type: string
1027
+ :mobilePhone:
1028
+ :type: string
1029
+ :residencialPhone:
1030
+ :type: string
1031
+ :businessPhone:
1032
+ :type: string
1033
+ :contactPhone:
1034
+ :type: string
1035
+ :grossIncome:
1036
+ :type: string
1037
+ :heritageValue:
1038
+ :type: string
1039
+ :motherName:
1040
+ :type: string
1041
+ :communicationSMSEmail:
1042
+ :type: string
1043
+ :politically:
1044
+ :type: string
1045
+ :birthDate:
1046
+ :type: string
1047
+ :personalData:
1048
+ :type:
1049
+ :type: object
1050
+ :properties:
1051
+ :clientCode:
1052
+ :type: string
1053
+ :cpf:
1054
+ :type: string
1055
+ :birthDate:
1056
+ :type: string
1057
+ :email:
1058
+ :type: string
1059
+ :naturalness:
1060
+ :type: string
1061
+ :name:
1062
+ :type: string
1063
+ :motherName:
1064
+ :type: string
1065
+ :politically:
1066
+ :type: string
1067
+ :grossIncome:
1068
+ :type: string
1069
+ :mobilePhone:
1070
+ :type: string
1071
+ :businessPhone:
1072
+ :type: string
1073
+ :contactPhone:
1074
+ :type: string
1075
+ :residencialPhone:
1076
+ :type: string
1077
+ :maritalStatusType:
1078
+ :type: string
1079
+ :nationalityType:
1080
+ :type: string
1081
+ :personType:
1082
+ :type: string
1083
+ :genderType:
1084
+ :type: string
1085
+ :heritageValue:
1086
+ :type: string
1087
+ :residencialAddress:
1088
+ :type: string
1089
+ :businessAddress:
1090
+ :type: string
1091
+ :addressInvoice:
1092
+ :type: string
1093
+ :accountSalary:
1094
+ :type: string
1095
+ :identity:
1096
+ :type:
1097
+ :type: object
1098
+ :properties:
1099
+ :issuingEntity:
1100
+ :type: string
1101
+ :unitFederativeType:
1102
+ :type: string
1103
+ :number:
1104
+ :type: string
1105
+ :dateIssue:
1106
+ :type: string
1107
+ :error:
1108
+ :type: string
1109
+ :errors:
1110
+ :type: string
1111
+ :api:
1112
+ :type: string
1113
+ :apiUrl:
1114
+ :type: string
1115
+ "/operation-data/accounts":
1116
+ put:
1117
+ :summary: Account Data
1118
+ :consumes:
1119
+ - application/json
1120
+ :parameters:
1121
+ - :content:
1122
+ :application/json:
1123
+ :schema:
1124
+ :type: object
1125
+ :properties:
1126
+ :accountNumber:
1127
+ :type: string
1128
+ :accountType:
1129
+ :type: string
1130
+ :agencyNumber:
1131
+ :type: string
1132
+ :bankNumber:
1133
+ :type: string
1134
+ :digitAccountVerifier:
1135
+ :type: string
1136
+ :digitAgencyVerifier:
1137
+ :type: string
1138
+ :identifier:
1139
+ :type: string
1140
+ :covenantCode:
1141
+ :type: string
1142
+ :institutionCode:
1143
+ :type: string
1144
+ :customerPassword:
1145
+ :type: string
1146
+ :reservationCodeMargin:
1147
+ :type: string
1148
+ :formVersion:
1149
+ :type: string
1150
+ :salesCpf:
1151
+ :type: string
1152
+ :salesRegistration:
1153
+ :type: string
1154
+ :paymentForm:
1155
+ :type: string
1156
+ :recipient:
1157
+ :type: string
1158
+ :customerCpf:
1159
+ :type: string
1160
+ :responses:
1161
+ :200:
1162
+ :application/json:
1163
+ :schema:
1164
+ :type: object
1165
+ :properties:
1166
+ :status:
1167
+ :type: integer
1168
+ :resultData:
1169
+ :type:
1170
+ :type: object
1171
+ :properties:
1172
+ :identifier:
1173
+ :type: string
1174
+ :accountCode:
1175
+ :type: string
1176
+ :bankNumber:
1177
+ :type: string
1178
+ :agencyNumber:
1179
+ :type: string
1180
+ :digitAgencyVerifier:
1181
+ :type: string
1182
+ :accountNumber:
1183
+ :type: string
1184
+ :digitAccountVerifier:
1185
+ :type: string
1186
+ :accountType:
1187
+ :type: string
1188
+ :error:
1189
+ :type: string
1190
+ :errors:
1191
+ :type: string
1192
+ :api:
1193
+ :type: string
1194
+ :apiUrl:
1195
+ :type: string
1196
+ "/prospects":
1197
+ post:
1198
+ :summary: Prospects
1199
+ :consumes:
1200
+ - application/json
1201
+ :parameters:
1202
+ - :content:
1203
+ :application/json:
1204
+ :schema:
1205
+ :type: object
1206
+ :properties:
1207
+ :correspondentCode:
1208
+ :type: string
1209
+ :businessUnitCode:
1210
+ :type: string
1211
+ :cpf:
1212
+ :type: string
1213
+ :storeCode:
1214
+ :type: string
1215
+ :systemTypeOriginatedProposal:
1216
+ :type: string
1217
+ :responses:
1218
+ :200:
1219
+ :application/json:
1220
+ :schema:
1221
+ :type: object
1222
+ :properties:
1223
+ :status:
1224
+ :type: integer
1225
+ :resultData:
1226
+ :type:
1227
+ :type: object
1228
+ :properties:
1229
+ :prospectIdentifier:
1230
+ :type: string
1231
+ :dateRegister:
1232
+ :type: string
1233
+ :cpf:
1234
+ :type: string
1235
+ :loginUserFunction:
1236
+ :type: string
1237
+ :error:
1238
+ :type: string
1239
+ :errors:
1240
+ :type: string
1241
+ :api:
1242
+ :type: string
1243
+ :apiUrl:
1244
+ :type: string
1245
+ "/states/{federativeUnit}/cities":
1246
+ get:
1247
+ :summary: Cities by State
1248
+ :consumes:
1249
+ - application/json
1250
+ :parameters:
1251
+ - :name: federativeUnit
1252
+ :in: path
1253
+ :required: true
1254
+ :schema:
1255
+ :type: string
1256
+ :responses:
1257
+ :200:
1258
+ :application/json:
1259
+ :schema:
1260
+ :type: object
1261
+ :properties:
1262
+ :status:
1263
+ :type: integer
1264
+ :resultData:
1265
+ :type: array
1266
+ :error:
1267
+ :type: string
1268
+ :errors:
1269
+ :type: string
1270
+ :api:
1271
+ :type: string
1272
+ :apiUrl:
1273
+ :type: string
1274
+ "/covenants/{covenantCode}/simulations/commons":
1275
+ get:
1276
+ :summary: Common Simulation
1277
+ :consumes:
1278
+ - application/json
1279
+ :parameters:
1280
+ - :name: covenantCode
1281
+ :in: path
1282
+ :required: true
1283
+ :schema:
1284
+ :type: string
1285
+ :responses:
1286
+ :200:
1287
+ :application/json:
1288
+ :schema:
1289
+ :type: object
1290
+ :properties:
1291
+ :status:
1292
+ :type: integer
1293
+ :resultData:
1294
+ :type:
1295
+ :type: object
1296
+ :properties:
1297
+ :registerValidation:
1298
+ :type:
1299
+ :type: object
1300
+ :properties:
1301
+ :format:
1302
+ :type: string
1303
+ :size:
1304
+ :type: integer
1305
+ :benefitList:
1306
+ :type: array
1307
+ :institutionsCovenantList:
1308
+ :type: array
1309
+ :error:
1310
+ :type: string
1311
+ :errors:
1312
+ :type: string
1313
+ :api:
1314
+ :type: string
1315
+ :apiUrl:
1316
+ :type: string
1317
+ "/documents/required/products/{productCode}":
1318
+ get:
1319
+ :summary: Required Documents
1320
+ :consumes:
1321
+ - application/json
1322
+ :parameters:
1323
+ - :name: productCode
1324
+ :in: path
1325
+ :required: true
1326
+ :schema:
1327
+ :type: string
1328
+ :responses:
1329
+ :200:
1330
+ :application/json:
1331
+ :schema:
1332
+ :type: object
1333
+ :properties:
1334
+ :status:
1335
+ :type: integer
1336
+ :resultData:
1337
+ :type:
1338
+ :type: object
1339
+ :properties:
1340
+ :productCode:
1341
+ :type: string
1342
+ :requiredDocuments:
1343
+ :type: array
1344
+ :error:
1345
+ :type: string
1346
+ :errors:
1347
+ :type: string
1348
+ :api:
1349
+ :type: string
1350
+ :apiUrl:
1351
+ :type: string
1352
+ "/prospects/{prospectIdentifier}/summaries":
1353
+ get:
1354
+ :summary: Prospects Summary
1355
+ :consumes:
1356
+ - application/json
1357
+ :parameters:
1358
+ - :name: prospectIdentifier
1359
+ :in: path
1360
+ :required: true
1361
+ :schema:
1362
+ :type: string
1363
+ :responses:
1364
+ :200:
1365
+ :application/json:
1366
+ :schema:
1367
+ :type: object
1368
+ :properties:
1369
+ :status:
1370
+ :type: integer
1371
+ :resultData:
1372
+ :type:
1373
+ :type: object
1374
+ :properties:
1375
+ :proposalIdentifier:
1376
+ :type: string
1377
+ :registration:
1378
+ :type: string
1379
+ :grossIncome:
1380
+ :type: integer
1381
+ :heritageValue:
1382
+ :type: integer
1383
+ :motherName:
1384
+ :type: string
1385
+ :communicationSMSEmail:
1386
+ :type: string
1387
+ :politically:
1388
+ :type: string
1389
+ :personType:
1390
+ :type: integer
1391
+ :personTypelDescription:
1392
+ :type: string
1393
+ :productData:
1394
+ :type:
1395
+ :type: object
1396
+ :properties:
1397
+ :proposalIdentifier:
1398
+ :type: string
1399
+ :birthDate:
1400
+ :type: string
1401
+ :productCode:
1402
+ :type: string
1403
+ :benefitCode:
1404
+ :type: string
1405
+ :benefitName:
1406
+ :type: string
1407
+ :nameSpecieBenefit:
1408
+ :type: string
1409
+ :codeSpecieBenefit:
1410
+ :type: string
1411
+ :institutionCode:
1412
+ :type: string
1413
+ :institutionName:
1414
+ :type: string
1415
+ :covenantCode:
1416
+ :type: string
1417
+ :covenantName:
1418
+ :type: string
1419
+ :operationCode:
1420
+ :type: string
1421
+ :operationName:
1422
+ :type: string
1423
+ :typeOperationCode:
1424
+ :type: string
1425
+ :typeOperationName:
1426
+ :type: string
1427
+ :productName:
1428
+ :type: string
1429
+ :releaseData:
1430
+ :type:
1431
+ :type: object
1432
+ :properties:
1433
+ :accountCode:
1434
+ :type: string
1435
+ :releaseDate:
1436
+ :type: string
1437
+ :cpfRecipient:
1438
+ :type: string
1439
+ :paymentType:
1440
+ :type: integer
1441
+ :paymentTypeDescription:
1442
+ :type: string
1443
+ :releasedValue:
1444
+ :type: string
1445
+ :benefitType:
1446
+ :type: integer
1447
+ :benefitTypeDescription:
1448
+ :type: string
1449
+ :operationData:
1450
+ :type:
1451
+ :type: object
1452
+ :properties:
1453
+ :institutionCode:
1454
+ :type: string
1455
+ :institutionName:
1456
+ :type: string
1457
+ :customerPassword:
1458
+ :type: string
1459
+ :reservationCodeMargin:
1460
+ :type: string
1461
+ :formVersion:
1462
+ :type: string
1463
+ :cpfSeller:
1464
+ :type: string
1465
+ :registrationSeller:
1466
+ :type: string
1467
+ :registrationCustomer:
1468
+ :type: string
1469
+ :typeInvoiceReceipt:
1470
+ :type: string
1471
+ :identityCustomer:
1472
+ :type:
1473
+ :type: object
1474
+ :properties:
1475
+ :issuingEntity:
1476
+ :type: string
1477
+ :unitFederativeType:
1478
+ :type: integer
1479
+ :unitFederativeTypeDescription:
1480
+ :type: string
1481
+ :number:
1482
+ :type: string
1483
+ :dateIssue:
1484
+ :type: string
1485
+ :dataProposalStatus:
1486
+ :type: string
1487
+ :initialData:
1488
+ :type:
1489
+ :type: object
1490
+ :properties:
1491
+ :proposalIdentifier:
1492
+ :type: string
1493
+ :dateRegister:
1494
+ :type: string
1495
+ :cpf:
1496
+ :type: string
1497
+ :dataBase:
1498
+ :type: string
1499
+ :status:
1500
+ :type: integer
1501
+ :prospectPhase:
1502
+ :type: string
1503
+ :loginUserFunction:
1504
+ :type: string
1505
+ :proposalNumber:
1506
+ :type: string
1507
+ :correspondentCode:
1508
+ :type: string
1509
+ :correspondentName:
1510
+ :type: string
1511
+ :userCode:
1512
+ :type: string
1513
+ :userName:
1514
+ :type: string
1515
+ :operatorCode:
1516
+ :type: string
1517
+ :storeCode:
1518
+ :type: string
1519
+ :businessUnitCode:
1520
+ :type: string
1521
+ :customerData:
1522
+ :type:
1523
+ :type: object
1524
+ :properties:
1525
+ :proposalIdentifier:
1526
+ :type: string
1527
+ :locator:
1528
+ :type: string
1529
+ :dateRegister:
1530
+ :type: string
1531
+ :cpf:
1532
+ :type: string
1533
+ :name:
1534
+ :type: string
1535
+ :email:
1536
+ :type: string
1537
+ :gender:
1538
+ :type: integer
1539
+ :genderDescription:
1540
+ :type: string
1541
+ :maritalStatus:
1542
+ :type: integer
1543
+ :maritalStatusDescription:
1544
+ :type: string
1545
+ :nationalityType:
1546
+ :type: string
1547
+ :nationalityTypeDescription:
1548
+ :type: string
1549
+ :naturalness:
1550
+ :type: string
1551
+ :mobilePhone:
1552
+ :type: string
1553
+ :residentialPhone:
1554
+ :type: string
1555
+ :businessPhone:
1556
+ :type: string
1557
+ :contactPhone:
1558
+ :type: string
1559
+ :registration:
1560
+ :type: string
1561
+ :heritageValue:
1562
+ :type: string
1563
+ :grossIncome:
1564
+ :type: string
1565
+ :communicationSMSEmail:
1566
+ :type: string
1567
+ :politically:
1568
+ :type: string
1569
+ :customerCode:
1570
+ :type: string
1571
+ :birthDate:
1572
+ :type: string
1573
+ :motherName:
1574
+ :type: string
1575
+ :maritalStatusType:
1576
+ :type: string
1577
+ :personType:
1578
+ :type: string
1579
+ :genderType:
1580
+ :type: string
1581
+ :identityNumber:
1582
+ :type: string
1583
+ :organizationInssuingIdentity:
1584
+ :type: string
1585
+ :ufrgType:
1586
+ :type: string
1587
+ :identityEmissionDate:
1588
+ :type: string
1589
+ :address:
1590
+ :type:
1591
+ :type: object
1592
+ :properties:
1593
+ :addressCode:
1594
+ :type: string
1595
+ :proposalIdentifier:
1596
+ :type: string
1597
+ :zipCode:
1598
+ :type: string
1599
+ :streetType:
1600
+ :type: integer
1601
+ :streetTypeDescription:
1602
+ :type: string
1603
+ :street:
1604
+ :type: string
1605
+ :complement:
1606
+ :type: string
1607
+ :neighborhood:
1608
+ :type: string
1609
+ :city:
1610
+ :type: string
1611
+ :unitFederativeType:
1612
+ :type: integer
1613
+ :unitFederativeTypeDescription:
1614
+ :type: string
1615
+ :addressType:
1616
+ :type: integer
1617
+ :addressTypeDescription:
1618
+ :type: string
1619
+ :receiveInvoice:
1620
+ :type: string
1621
+ :number:
1622
+ :type: string
1623
+ :accountBankData:
1624
+ :type:
1625
+ :type: object
1626
+ :properties:
1627
+ :accountCode:
1628
+ :type: string
1629
+ :digitAgencyVerifier:
1630
+ :type: string
1631
+ :digitAccountVerifier:
1632
+ :type: string
1633
+ :agencyNumber:
1634
+ :type: string
1635
+ :bankName:
1636
+ :type: string
1637
+ :bankNumber:
1638
+ :type: string
1639
+ :accountNumber:
1640
+ :type: string
1641
+ :receivePayment:
1642
+ :type: string
1643
+ :accountType:
1644
+ :type: integer
1645
+ :accountTypeDescription:
1646
+ :type: string
1647
+ :simulationData:
1648
+ :type:
1649
+ :type: object
1650
+ :properties:
1651
+ :financedAmount:
1652
+ :type: string
1653
+ :plotValue:
1654
+ :type: integer
1655
+ :plotQuantity:
1656
+ :type: integer
1657
+ :releaseDate:
1658
+ :type: string
1659
+ :dateFirstMaturity:
1660
+ :type: string
1661
+ :rateValueYear:
1662
+ :type: string
1663
+ :rateValueMonth:
1664
+ :type: string
1665
+ :cetRateYear:
1666
+ :type: string
1667
+ :cetRateMonth:
1668
+ :type: string
1669
+ :tccValue:
1670
+ :type: integer
1671
+ :iofValue:
1672
+ :type: integer
1673
+ :cpmfValue:
1674
+ :type: integer
1675
+ :error:
1676
+ :type: string
1677
+ :errors:
1678
+ :type: string
1679
+ :api:
1680
+ :type: string
1681
+ :apiUrl:
1682
+ :type: string
1683
+ :404:
1684
+ :application/json:
1685
+ :schema:
1686
+ :type: object
1687
+ :properties:
1688
+ :status:
1689
+ :type: integer
1690
+ :resultData:
1691
+ :type: string
1692
+ :error:
1693
+ :type:
1694
+ :type: object
1695
+ :properties:
1696
+ :code:
1697
+ :type: string
1698
+ :description:
1699
+ :type: string
1700
+ :errors:
1701
+ :type: string
1702
+ :api:
1703
+ :type: string
1704
+ :apiUrl:
1705
+ :type: string
1706
+ "/operation-data/prospects/{prospectIdentifier}":
1707
+ delete:
1708
+ :summary: Restart Operation Data
1709
+ :consumes:
1710
+ - application/json
1711
+ :parameters:
1712
+ - :name: prospectIdentifier
1713
+ :in: path
1714
+ :required: true
1715
+ :schema:
1716
+ :type: string
1717
+ :responses:
1718
+ :200:
1719
+ :application/json:
1720
+ :schema:
1721
+ :type: object
1722
+ :properties:
1723
+ :status:
1724
+ :type: integer
1725
+ :resultData:
1726
+ :type:
1727
+ :type: object
1728
+ :properties:
1729
+ :restartData:
1730
+ :type: string
1731
+ :prospectIdentifier:
1732
+ :type: string
1733
+ :error:
1734
+ :type: string
1735
+ :errors:
1736
+ :type: string
1737
+ :api:
1738
+ :type: string
1739
+ :apiUrl:
1740
+ :type: string
1741
+ "/simulations/covenants":
1742
+ put:
1743
+ :summary: Simulation by Covenant
1744
+ :consumes:
1745
+ - application/json
1746
+ :parameters:
1747
+ - :content:
1748
+ :application/json:
1749
+ :schema:
1750
+ :type: object
1751
+ :properties:
1752
+ :registration:
1753
+ :type: string
1754
+ :prospectIdentifier:
1755
+ :type: string
1756
+ :birthDate:
1757
+ :type: string
1758
+ :covenantCode:
1759
+ :type: string
1760
+ :institutionCode:
1761
+ :type: string
1762
+ :benefitCode:
1763
+ :type: string
1764
+ :correspondentCode:
1765
+ :type: string
1766
+ :storeCode:
1767
+ :type: string
1768
+ :businessUnitCode:
1769
+ :type: string
1770
+ :cpf:
1771
+ :type: string
1772
+ :plotValue:
1773
+ :type: string
1774
+ :responses:
1775
+ :200:
1776
+ :application/json:
1777
+ :schema:
1778
+ :type: object
1779
+ :properties:
1780
+ :status:
1781
+ :type: integer
1782
+ :resultData:
1783
+ :type:
1784
+ :type: object
1785
+ :properties:
1786
+ :identifierProposal:
1787
+ :type: string
1788
+ :resultSimulation:
1789
+ :type: string
1790
+ :validRegistration:
1791
+ :type: string
1792
+ :operationList:
1793
+ :type: array
1794
+ :error:
1795
+ :type: string
1796
+ :errors:
1797
+ :type: string
1798
+ :api:
1799
+ :type: string
1800
+ :apiUrl:
1801
+ :type: string
1802
+ "/products/{productCode}/parameterizations":
1803
+ get:
1804
+ :summary: Product Parameterizations
1805
+ :consumes:
1806
+ - application/json
1807
+ :parameters:
1808
+ - :name: productCode
1809
+ :in: path
1810
+ :required: true
1811
+ :schema:
1812
+ :type: string
1813
+ :responses:
1814
+ :200:
1815
+ :application/json:
1816
+ :schema:
1817
+ :type: object
1818
+ :properties:
1819
+ :status:
1820
+ :type: integer
1821
+ :resultData:
1822
+ :type:
1823
+ :type: object
1824
+ :properties:
1825
+ :productCode:
1826
+ :type: string
1827
+ :marginPercentage:
1828
+ :type: string
1829
+ :error:
1830
+ :type: string
1831
+ :errors:
1832
+ :type: string
1833
+ :api:
1834
+ :type: string
1835
+ :apiUrl:
1836
+ :type: string
1837
+ "/proposals/{proposalIdentifier}/summaries":
1838
+ get:
1839
+ :summary: Proposals Summary
1840
+ :consumes:
1841
+ - application/json
1842
+ :parameters:
1843
+ - :name: proposalIdentifier
1844
+ :in: path
1845
+ :required: true
1846
+ :schema:
1847
+ :type: string
1848
+ - :content:
1849
+ :application/json:
1850
+ :schema:
1851
+ :type: object
1852
+ :properties:
1853
+ :status:
1854
+ :type: integer
1855
+ :resultData:
1856
+ :type:
1857
+ :type: object
1858
+ :properties:
1859
+ :proposalIdentifier:
1860
+ :type: string
1861
+ :registration:
1862
+ :type: string
1863
+ :grossIncome:
1864
+ :type: string
1865
+ :heritageValue:
1866
+ :type: string
1867
+ :motherName:
1868
+ :type: string
1869
+ :communicationSMSEmail:
1870
+ :type: string
1871
+ :politically:
1872
+ :type: string
1873
+ :personType:
1874
+ :type: string
1875
+ :productData:
1876
+ :type:
1877
+ :type: object
1878
+ :properties:
1879
+ :proposalIdentifier:
1880
+ :type: string
1881
+ :birthDate:
1882
+ :type: string
1883
+ :productCode:
1884
+ :type: string
1885
+ :benefitCode:
1886
+ :type: string
1887
+ :benefitName:
1888
+ :type: string
1889
+ :nameSpecieBenefit:
1890
+ :type: string
1891
+ :codeSpecieBenefit:
1892
+ :type: string
1893
+ :institutionCode:
1894
+ :type: string
1895
+ :institutionName:
1896
+ :type: string
1897
+ :covenantCode:
1898
+ :type: string
1899
+ :covenantName:
1900
+ :type: string
1901
+ :operationCode:
1902
+ :type: string
1903
+ :operationName:
1904
+ :type: string
1905
+ :typeOperationCode:
1906
+ :type: string
1907
+ :typeOperationName:
1908
+ :type: string
1909
+ :productName:
1910
+ :type: string
1911
+ :releaseData:
1912
+ :type:
1913
+ :type: object
1914
+ :properties:
1915
+ :accountCode:
1916
+ :type: string
1917
+ :releaseDate:
1918
+ :type: string
1919
+ :cpfRecipient:
1920
+ :type: string
1921
+ :paymentType:
1922
+ :type: string
1923
+ :releasedValue:
1924
+ :type: string
1925
+ :benefitType:
1926
+ :type: string
1927
+ :operationData:
1928
+ :type:
1929
+ :type: object
1930
+ :properties:
1931
+ :institutionCode:
1932
+ :type: string
1933
+ :institutionName:
1934
+ :type: string
1935
+ :customerPassword:
1936
+ :type: string
1937
+ :reservationCodeMargin:
1938
+ :type: string
1939
+ :formVersion:
1940
+ :type: string
1941
+ :cpfSeller:
1942
+ :type: string
1943
+ :registrationSeller:
1944
+ :type: string
1945
+ :registrationCustomer:
1946
+ :type: string
1947
+ :typeInvoiceReceipt:
1948
+ :type: string
1949
+ :identityCustomer:
1950
+ :type: string
1951
+ :dataProposalStatus:
1952
+ :type:
1953
+ :type: object
1954
+ :properties:
1955
+ :datePhaseUpdated:
1956
+ :type: string
1957
+ :treadmill:
1958
+ :type: integer
1959
+ :phaseCode:
1960
+ :type: integer
1961
+ :descriptionPhase:
1962
+ :type: string
1963
+ :macroStatusCode:
1964
+ :type: integer
1965
+ :macroStatus:
1966
+ :type: string
1967
+ :detailStatusCode:
1968
+ :type: integer
1969
+ :detailStatus:
1970
+ :type: string
1971
+ :initialData:
1972
+ :type:
1973
+ :type: object
1974
+ :properties:
1975
+ :proposalIdentifier:
1976
+ :type: string
1977
+ :dateRegister:
1978
+ :type: string
1979
+ :cpf:
1980
+ :type: string
1981
+ :dataBase:
1982
+ :type: string
1983
+ :status:
1984
+ :type: string
1985
+ :prospectPhase:
1986
+ :type: string
1987
+ :loginUserFunction:
1988
+ :type: string
1989
+ :proposalNumber:
1990
+ :type: string
1991
+ :correspondentCode:
1992
+ :type: string
1993
+ :correspondentName:
1994
+ :type: string
1995
+ :userCode:
1996
+ :type: string
1997
+ :userName:
1998
+ :type: string
1999
+ :operatorCode:
2000
+ :type: string
2001
+ :storeCode:
2002
+ :type: string
2003
+ :businessUnitCode:
2004
+ :type: string
2005
+ :customerData:
2006
+ :type:
2007
+ :type: object
2008
+ :properties:
2009
+ :proposalIdentifier:
2010
+ :type: string
2011
+ :locator:
2012
+ :type: string
2013
+ :dateRegister:
2014
+ :type: string
2015
+ :cpf:
2016
+ :type: string
2017
+ :name:
2018
+ :type: string
2019
+ :email:
2020
+ :type: string
2021
+ :gender:
2022
+ :type: string
2023
+ :maritalStatus:
2024
+ :type: string
2025
+ :nationalityType:
2026
+ :type: string
2027
+ :naturalness:
2028
+ :type: string
2029
+ :mobilePhone:
2030
+ :type: string
2031
+ :residentialPhone:
2032
+ :type: string
2033
+ :businessPhone:
2034
+ :type: string
2035
+ :contactPhone:
2036
+ :type: string
2037
+ :register:
2038
+ :type: string
2039
+ :heritageValue:
2040
+ :type: string
2041
+ :grossIncome:
2042
+ :type: string
2043
+ :communicationSMSEmail:
2044
+ :type: integer
2045
+ :politically:
2046
+ :type: integer
2047
+ :customerCode:
2048
+ :type: string
2049
+ :birthDate:
2050
+ :type: string
2051
+ :motherName:
2052
+ :type: string
2053
+ :maritalStatusType:
2054
+ :type: string
2055
+ :personType:
2056
+ :type: string
2057
+ :genderType:
2058
+ :type: string
2059
+ :identityNumber:
2060
+ :type: string
2061
+ :organizationInssuingIdentity:
2062
+ :type: string
2063
+ :ufrgType:
2064
+ :type: string
2065
+ :identityEmissionDate:
2066
+ :type: string
2067
+ :address:
2068
+ :type:
2069
+ :type: object
2070
+ :properties:
2071
+ :addressCode:
2072
+ :type: string
2073
+ :proposalIdentifier:
2074
+ :type: string
2075
+ :zipCode:
2076
+ :type: string
2077
+ :streetType:
2078
+ :type: string
2079
+ :street:
2080
+ :type: string
2081
+ :complement:
2082
+ :type: string
2083
+ :neighborhood:
2084
+ :type: string
2085
+ :city:
2086
+ :type: string
2087
+ :unitFederativeType:
2088
+ :type: string
2089
+ :addressType:
2090
+ :type: string
2091
+ :receiveInvoice:
2092
+ :type: string
2093
+ :number:
2094
+ :type: string
2095
+ :accountBankData:
2096
+ :type:
2097
+ :type: object
2098
+ :properties:
2099
+ :accountCode:
2100
+ :type: string
2101
+ :digitAgencyVerifier:
2102
+ :type: string
2103
+ :digitAccountVerifier:
2104
+ :type: string
2105
+ :agencyNumber:
2106
+ :type: string
2107
+ :bankName:
2108
+ :type: string
2109
+ :bankNumber:
2110
+ :type: string
2111
+ :accountNumber:
2112
+ :type: string
2113
+ :receivePayment:
2114
+ :type: string
2115
+ :accountType:
2116
+ :type: string
2117
+ :simulationData:
2118
+ :type:
2119
+ :type: object
2120
+ :properties:
2121
+ :financedAmount:
2122
+ :type: string
2123
+ :plotValue:
2124
+ :type: string
2125
+ :plotQuantity:
2126
+ :type: integer
2127
+ :releaseDate:
2128
+ :type: string
2129
+ :dateFirstMaturity:
2130
+ :type: string
2131
+ :rateValueYear:
2132
+ :type: string
2133
+ :rateValueMonth:
2134
+ :type: string
2135
+ :cetRateYear:
2136
+ :type: string
2137
+ :cetRateMonth:
2138
+ :type: string
2139
+ :tccValue:
2140
+ :type: integer
2141
+ :iofValue:
2142
+ :type: string
2143
+ :cpmfValue:
2144
+ :type: integer
2145
+ :error:
2146
+ :type: string
2147
+ :errors:
2148
+ :type: string
2149
+ :api:
2150
+ :type: string
2151
+ :apiUrl:
2152
+ :type: string
2153
+ :responses: {}
2154
+ "/covenants/customers/{cpf}":
2155
+ get:
2156
+ :summary: Initial Data Simulation Covenant
2157
+ :consumes:
2158
+ - application/json
2159
+ :parameters:
2160
+ - :name: cpf
2161
+ :in: path
2162
+ :required: true
2163
+ :schema:
2164
+ :type: string
2165
+ - :name: :prospectIdentifier
2166
+ :in: query
2167
+ :description: identificador do prospect, para quando for edição
2168
+ :schema:
2169
+ :type: string
2170
+ :responses:
2171
+ :200:
2172
+ :application/json:
2173
+ :schema:
2174
+ :type: object
2175
+ :properties:
2176
+ :status:
2177
+ :type: integer
2178
+ :resultData:
2179
+ :type:
2180
+ :type: object
2181
+ :properties:
2182
+ :birthDate:
2183
+ :type: string
2184
+ :plotValue:
2185
+ :type: integer
2186
+ :covenantCode:
2187
+ :type: string
2188
+ :institutionCode:
2189
+ :type: string
2190
+ :benefitCode:
2191
+ :type: string
2192
+ :error:
2193
+ :type: string
2194
+ :errors:
2195
+ :type: string
2196
+ :api:
2197
+ :type: string
2198
+ :apiUrl:
2199
+ :type: string
2200
+ "/proposals/status":
2201
+ put:
2202
+ :summary: Proposals Status
2203
+ :consumes:
2204
+ - application/json
2205
+ :parameters:
2206
+ - :content:
2207
+ :application/json:
2208
+ :schema:
2209
+ :type: object
2210
+ :properties:
2211
+ :correspondentCode:
2212
+ :type: string
2213
+ :finalDate:
2214
+ :type: string
2215
+ :startDate:
2216
+ :type: string
2217
+ :actuationForm:
2218
+ :type: string
2219
+ :ordination:
2220
+ :type: integer
2221
+ :take:
2222
+ :type: integer
2223
+ :skip:
2224
+ :type: integer
2225
+ :cpf:
2226
+ :type: string
2227
+ :proposalIdentifier:
2228
+ :type: string
2229
+ :statusList:
2230
+ :type: array
2231
+ :responses:
2232
+ :200:
2233
+ :application/json:
2234
+ :schema:
2235
+ :type: object
2236
+ :properties:
2237
+ :status:
2238
+ :type: integer
2239
+ :resultData:
2240
+ :type:
2241
+ :type: object
2242
+ :properties:
2243
+ :totalProposals:
2244
+ :type: integer
2245
+ :proposalsList:
2246
+ :type: array
2247
+ :error:
2248
+ :type: string
2249
+ :errors:
2250
+ :type: string
2251
+ :api:
2252
+ :type: string
2253
+ :apiUrl:
2254
+ :type: string
2255
+ "/prospects/{prospectIdentifier}":
2256
+ delete:
2257
+ :summary: Cancel Prospects
2258
+ :consumes:
2259
+ - application/json
2260
+ :parameters:
2261
+ - :name: prospectIdentifier
2262
+ :in: path
2263
+ :required: true
2264
+ :schema:
2265
+ :type: string
2266
+ :responses:
2267
+ :200:
2268
+ :application/json:
2269
+ :schema:
2270
+ :type: object
2271
+ :properties:
2272
+ :status:
2273
+ :type: integer
2274
+ :resultData:
2275
+ :type:
2276
+ :type: object
2277
+ :properties:
2278
+ :proposalIdentifier:
2279
+ :type: string
2280
+ :canceled:
2281
+ :type: string
2282
+ :error:
2283
+ :type: string
2284
+ :errors:
2285
+ :type: string
2286
+ :api:
2287
+ :type: string
2288
+ :apiUrl:
2289
+ :type: string