Class: FactPulse::AFNORPDPPAApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AFNORPDPPAApi

Returns a new instance of AFNORPDPPAApi.



19
20
21
 
# File 'lib/factpulse/api/afnorpdppa_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_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_afnor_credentials_api_v1_afnor_credentials_get(opts = {}) ⇒ Object

Retrieve stored AFNOR credentials Retrieves stored AFNOR/PDP credentials for the JWT’s client_uid. This endpoint is used by the SDK in ‘stored’ mode to retrieve credentials before performing AFNOR OAuth itself.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


26
27
28
29
 
# File 'lib/factpulse/api/afnorpdppa_api.rb', line 26

def get_afnor_credentials_api_v1_afnor_credentials_get(opts = {})
  data, _status_code, _headers = get_afnor_credentials_api_v1_afnor_credentials_get_with_http_info(opts)
  data
end

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

Retrieve stored AFNOR credentials Retrieves stored AFNOR/PDP credentials for the JWT&#39;s client_uid. This endpoint is used by the SDK in &#39;stored&#39; mode to retrieve credentials before performing AFNOR OAuth itself.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



35
36
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
 
# File 'lib/factpulse/api/afnorpdppa_api.rb', line 35

def get_afnor_credentials_api_v1_afnor_credentials_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AFNORPDPPAApi.get_afnor_credentials_api_v1_afnor_credentials_get ...'
  end
  # resource path
  local_var_path = '/api/v1/afnor/credentials'

  # 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] || ['HTTPBearer']

  new_options = opts.merge(
    :operation => :"AFNORPDPPAApi.get_afnor_credentials_api_v1_afnor_credentials_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: AFNORPDPPAApi#get_afnor_credentials_api_v1_afnor_credentials_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get(flow_id, opts = {}) ⇒ IncomingInvoice

Retrieve and extract an incoming invoice Downloads an incoming flow from the AFNOR PDP and extracts invoice metadata into a unified JSON format. Supports Factur-X, CII, and UBL formats.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_document (Boolean) — default: default to false

Returns:



85
86
87
88
 
# File 'lib/factpulse/api/afnorpdppa_api.rb', line 85

def get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get(flow_id, opts = {})
  data, _status_code, _headers = get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get_with_http_info(flow_id, opts)
  data
end

#get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get_with_http_info(flow_id, opts = {}) ⇒ Array<(IncomingInvoice, Integer, Hash)>

Retrieve and extract an incoming invoice Downloads an incoming flow from the AFNOR PDP and extracts invoice metadata into a unified JSON format. Supports Factur-X, CII, and UBL formats.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_document (Boolean) — default: default to false

Returns:

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

    IncomingInvoice data, response status code and response headers



96
97
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
141
142
143
 
# File 'lib/factpulse/api/afnorpdppa_api.rb', line 96

def get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get_with_http_info(flow_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AFNORPDPPAApi.get_flux_entrant_api_v1_afnor_incoming_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 AFNORPDPPAApi.get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get"
  end
  # resource path
  local_var_path = '/api/v1/afnor/incoming-flows/{flow_id}'.sub('{' + 'flow_id' + '}', CGI.escape(flow_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_document'] = opts[:'include_document'] if !opts[:'include_document'].nil?

  # 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] || 'IncomingInvoice'

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

  new_options = opts.merge(
    :operation => :"AFNORPDPPAApi.get_flux_entrant_api_v1_afnor_incoming_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: AFNORPDPPAApi#get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#oauth_token_proxy_api_v1_afnor_oauth_token_post(opts = {}) ⇒ Object

OAuth2 endpoint for AFNOR authentication OAuth2 proxy endpoint to obtain an AFNOR access token. Proxies to AFNOR mock (sandbox) or real PDP depending on MOCK_AFNOR_BASE_URL. This endpoint is public (no Django auth required) as it is called by the AFNOR SDK.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


149
150
151
152
 
# File 'lib/factpulse/api/afnorpdppa_api.rb', line 149

def oauth_token_proxy_api_v1_afnor_oauth_token_post(opts = {})
  data, _status_code, _headers = oauth_token_proxy_api_v1_afnor_oauth_token_post_with_http_info(opts)
  data
end

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

OAuth2 endpoint for AFNOR authentication OAuth2 proxy endpoint to obtain an AFNOR access token. Proxies to AFNOR mock (sandbox) or real PDP depending on MOCK_AFNOR_BASE_URL. This endpoint is public (no Django auth required) as it is called by the AFNOR SDK.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
198
199
200
 
# File 'lib/factpulse/api/afnorpdppa_api.rb', line 158

def oauth_token_proxy_api_v1_afnor_oauth_token_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AFNORPDPPAApi.oauth_token_proxy_api_v1_afnor_oauth_token_post ...'
  end
  # resource path
  local_var_path = '/api/v1/afnor/oauth/token'

  # 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 => :"AFNORPDPPAApi.oauth_token_proxy_api_v1_afnor_oauth_token_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: AFNORPDPPAApi#oauth_token_proxy_api_v1_afnor_oauth_token_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end