Class: FactPulse::AFNORPDPPAFlowServiceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/factpulse/api/afnorpdppa_flow_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AFNORPDPPAFlowServiceApi

Returns a new instance of AFNORPDPPAFlowServiceApi.



19
20
21
 
# File 'lib/factpulse/api/afnorpdppa_flow_service_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/factpulse/api/afnorpdppa_flow_service_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get(flow_id, opts = {}) ⇒ Object

Télécharger un flux Télécharger le fichier PDF/A-3 d’un flux de facturation (utilise le client_uid du JWT)

Parameters:

  • flow_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


27
28
29
30
 
# File 'lib/factpulse/api/afnorpdppa_flow_service_api.rb', line 27

def download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get(flow_id, opts = {})
  data, _status_code, _headers = download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info(flow_id, opts)
  data
end

#download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info(flow_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Télécharger un flux Télécharger le fichier PDF/A-3 d&#39;un flux de facturation (utilise le client_uid du JWT)

Parameters:

  • flow_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/factpulse/api/afnorpdppa_flow_service_api.rb', line 37

def download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info(flow_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AFNORPDPPAFlowServiceApi.download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get ...'
  end
  # verify the required parameter 'flow_id' is set
  if @api_client.config.client_side_validation && flow_id.nil?
    fail ArgumentError, "Missing the required parameter 'flow_id' when calling AFNORPDPPAFlowServiceApi.download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get"
  end
  # resource path
  local_var_path = '/api/v1/afnor/flow/v1/flows/{flowId}'.sub('{' + 'flowId' + '}', CGI.escape(flow_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/pdf']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AFNORPDPPAFlowServiceApi.download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AFNORPDPPAFlowServiceApi#download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get(opts = {}) ⇒ Object

Healthcheck Flow Service Vérifier la disponibilité du Flow Service

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


89
90
91
92
 
# File 'lib/factpulse/api/afnorpdppa_flow_service_api.rb', line 89

def flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get(opts = {})
  data, _status_code, _headers = flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get_with_http_info(opts)
  data
end

#flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Healthcheck Flow Service Vérifier la disponibilité du Flow Service

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/factpulse/api/afnorpdppa_flow_service_api.rb', line 98

def flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AFNORPDPPAFlowServiceApi.flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get ...'
  end
  # resource path
  local_var_path = '/api/v1/afnor/flow/v1/healthcheck'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AFNORPDPPAFlowServiceApi.flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AFNORPDPPAFlowServiceApi#flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post(opts = {}) ⇒ Object

Rechercher des flux Rechercher des flux de facturation selon des critères (utilise le client_uid du JWT)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


146
147
148
149
 
# File 'lib/factpulse/api/afnorpdppa_flow_service_api.rb', line 146

def search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post(opts = {})
  data, _status_code, _headers = search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info(opts)
  data
end

#search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Rechercher des flux Rechercher des flux de facturation selon des critères (utilise le client_uid du JWT)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/factpulse/api/afnorpdppa_flow_service_api.rb', line 155

def search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AFNORPDPPAFlowServiceApi.search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post ...'
  end
  # resource path
  local_var_path = '/api/v1/afnor/flow/v1/flows/search'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AFNORPDPPAFlowServiceApi.search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AFNORPDPPAFlowServiceApi#search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#submit_flow_proxy_api_v1_afnor_flow_v1_flows_post(opts = {}) ⇒ Object

Soumettre un flux de facturation Soumet une facture électronique à une Plateforme de Dématérialisation Partenaire (PDP) conformément à la norme AFNOR XP Z12-013

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


203
204
205
206
 
# File 'lib/factpulse/api/afnorpdppa_flow_service_api.rb', line 203

def submit_flow_proxy_api_v1_afnor_flow_v1_flows_post(opts = {})
  data, _status_code, _headers = submit_flow_proxy_api_v1_afnor_flow_v1_flows_post_with_http_info(opts)
  data
end

#submit_flow_proxy_api_v1_afnor_flow_v1_flows_post_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Soumettre un flux de facturation Soumet une facture électronique à une Plateforme de Dématérialisation Partenaire (PDP) conformément à la norme AFNOR XP Z12-013

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/factpulse/api/afnorpdppa_flow_service_api.rb', line 212

def submit_flow_proxy_api_v1_afnor_flow_v1_flows_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AFNORPDPPAFlowServiceApi.submit_flow_proxy_api_v1_afnor_flow_v1_flows_post ...'
  end
  # resource path
  local_var_path = '/api/v1/afnor/flow/v1/flows'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AFNORPDPPAFlowServiceApi.submit_flow_proxy_api_v1_afnor_flow_v1_flows_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AFNORPDPPAFlowServiceApi#submit_flow_proxy_api_v1_afnor_flow_v1_flows_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end