factpulse 4.1.2 → 4.3.0
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 +4 -4
- data/CHANGELOG.md +5 -5
- data/Gemfile.lock +2 -2
- data/docs/AFNORBasicAuthentication.md +20 -0
- data/docs/AFNORCallbackAuthentication.md +49 -0
- data/docs/AFNORCallbackHeader.md +20 -0
- data/docs/AFNORCallbackParameters.md +24 -0
- data/docs/AFNORCallbackSignature.md +20 -0
- data/docs/{AFNORFacilityNature.md → AFNORContainsOrStrictOperator.md} +2 -2
- data/docs/AFNORCoreFlowInfo.md +26 -0
- data/docs/{AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode.md → AFNORDirectoryLinePayloadLegalUnitFacilityRoutingCode.md} +5 -5
- data/docs/AFNORDirectoryLinePayloadStatusLegalUnitFacilityRoutingCode.md +34 -0
- data/docs/AFNORDirectoryLineSearchPost200Response.md +1 -1
- data/docs/{AFNORDiffusionStatus.md → AFNORDirectoryLineStatus.md} +2 -2
- data/docs/AFNORError.md +4 -4
- data/docs/AFNORFacilityPayloadHistory.md +3 -3
- data/docs/AFNORFacilityPayloadIncluded.md +0 -2
- data/docs/AFNORFlow.md +16 -14
- data/docs/AFNORFlowExtension.md +26 -0
- data/docs/AFNORFlowInfo.md +3 -3
- data/docs/AFNORFlowInfoExtension.md +18 -0
- data/docs/AFNORFullFlowInfo.md +8 -8
- data/docs/AFNORFullFlowInfoExtension.md +20 -0
- data/docs/AFNORLegalUnitPayloadHistory.md +3 -1
- data/docs/AFNOROAuth2Authentication.md +22 -0
- data/docs/AFNORPDPPADirectoryServiceApi.md +4 -648
- data/docs/AFNORPDPPAFlowServiceApi.md +320 -1
- data/docs/AFNORRoutingCodeSearch.md +1 -1
- data/docs/AFNORRoutingCodeSearchFiltersRoutingCodeName.md +1 -1
- data/docs/AFNORRoutingCodeSearchFiltersRoutingIdentifier.md +1 -1
- data/docs/AFNORSearchDirectoryLine.md +2 -2
- data/docs/AFNORSearchDirectoryLineFiltersAddressingIdentifier.md +1 -1
- data/docs/AFNORSearchDirectoryLineFiltersAddressingSuffix.md +1 -1
- data/docs/AFNORSearchFlowFilters.md +1 -1
- data/docs/AFNORSearchSiren.md +1 -1
- data/docs/AFNORSearchSirenFiltersBusinessName.md +1 -1
- data/docs/AFNORSearchSirenFiltersSiren.md +1 -1
- data/docs/AFNORSearchSiret.md +2 -2
- data/docs/AFNORSearchSiretFiltersCountrySubdivision.md +1 -1
- data/docs/AFNORSearchSiretFiltersFacilityType.md +1 -1
- data/docs/AFNORSearchSiretFiltersLocality.md +1 -1
- data/docs/AFNORSearchSiretFiltersName.md +1 -1
- data/docs/AFNORSearchSiretFiltersPostalCode.md +1 -1
- data/docs/AFNORSearchSiretFiltersSiret.md +1 -1
- data/docs/AFNORSirenInstructions.md +18 -0
- data/docs/AFNORSiretInstructions.md +18 -0
- data/docs/{AFNORPlatformStatus.md → AFNORStrictOrStartWithOperator.md} +2 -2
- data/docs/AFNORWebhook.md +22 -0
- data/docs/AFNORWebhookIdParam.md +18 -0
- data/docs/AFNORWebhookMetadata.md +24 -0
- data/docs/AFNORWebhookParams.md +20 -0
- data/docs/AFNORWebhookPatchPayload.md +22 -0
- data/docs/ChorusProCredentials.md +8 -8
- data/docs/ChorusProDestination.md +1 -1
- data/docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md +24 -0
- data/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +15 -0
- data/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +26 -0
- data/docs/GetChorusProIdRequest.md +1 -1
- data/docs/GetInvoiceRequest.md +1 -1
- data/docs/GetStructureRequest.md +1 -1
- data/docs/InvoiceInput.md +1 -1
- data/docs/SearchStructureRequest.md +1 -1
- data/docs/SimplifiedInvoiceData.md +1 -1
- data/docs/SubmitInvoiceRequest.md +1 -1
- data/docs/ValidateCDARResponse.md +2 -2
- data/docs/ValidationErrorResponse.md +2 -8
- data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +3 -621
- data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +303 -0
- data/lib/factpulse/models/afnor_algorithm.rb +4 -3
- data/lib/factpulse/models/afnor_basic_authentication.rb +190 -0
- data/lib/factpulse/models/afnor_callback_authentication.rb +105 -0
- data/lib/factpulse/models/afnor_callback_header.rb +190 -0
- data/lib/factpulse/models/afnor_callback_parameters.rb +193 -0
- data/lib/factpulse/models/{afnor_directory_line_payload_history_legal_unit_facility_routing_code_platform.rb → afnor_callback_signature.rb} +51 -16
- data/lib/factpulse/models/{afnor_diffusion_status.rb → afnor_contains_or_strict_operator.rb} +6 -6
- data/lib/factpulse/models/{afnor_routing_code_post201_response.rb → afnor_core_flow_info.rb} +103 -61
- data/lib/factpulse/models/afnor_directory_line_field.rb +1 -2
- data/lib/factpulse/models/{afnor_directory_line_payload_history_legal_unit_facility_routing_code.rb → afnor_directory_line_payload_legal_unit_facility_routing_code.rb} +36 -14
- data/lib/factpulse/models/{afnor_create_directory_line_body_addressing_information.rb → afnor_directory_line_payload_status_legal_unit_facility_routing_code.rb} +105 -56
- data/lib/factpulse/models/afnor_directory_line_search_post200_response.rb +1 -1
- data/lib/factpulse/models/{afnor_platform_status.rb → afnor_directory_line_status.rb} +5 -4
- data/lib/factpulse/models/afnor_error.rb +30 -39
- data/lib/factpulse/models/afnor_facility_payload_history.rb +11 -11
- data/lib/factpulse/models/afnor_facility_payload_included.rb +1 -10
- data/lib/factpulse/models/afnor_flow.rb +218 -57
- data/lib/factpulse/models/{afnor_update_patch_routing_code_body.rb → afnor_flow_extension.rb} +103 -66
- data/lib/factpulse/models/afnor_flow_info.rb +20 -4
- data/lib/factpulse/models/{afnor_create_directory_line_body_period.rb → afnor_flow_info_extension.rb} +26 -31
- data/lib/factpulse/models/afnor_full_flow_info.rb +79 -46
- data/lib/factpulse/models/afnor_full_flow_info_extension.rb +202 -0
- data/lib/factpulse/models/afnor_legal_unit_payload_history.rb +13 -4
- data/lib/factpulse/models/afnor_processing_rule.rb +4 -1
- data/lib/factpulse/models/afnor_routing_code_field.rb +1 -2
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_code_name.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_identifier.rb +1 -1
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_identifier.rb +1 -1
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_suffix.rb +1 -1
- data/lib/factpulse/models/afnor_search_flow_filters.rb +1 -0
- data/lib/factpulse/models/afnor_search_siren_filters_business_name.rb +1 -1
- data/lib/factpulse/models/afnor_search_siren_filters_siren.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_country_subdivision.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_facility_type.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_locality.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_name.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_postal_code.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_siret.rb +1 -1
- data/lib/factpulse/models/afnor_siren_field.rb +2 -2
- data/lib/factpulse/models/{afnor_update_patch_directory_line_body.rb → afnor_siren_instructions.rb} +12 -11
- data/lib/factpulse/models/afnor_siret_field.rb +3 -4
- data/lib/factpulse/models/{afnor_create_directory_line_body.rb → afnor_siret_instructions.rb} +12 -19
- data/lib/factpulse/models/{afnor_facility_nature.rb → afnor_strict_or_start_with_operator.rb} +6 -6
- data/lib/factpulse/models/{afnor_directory_line_post201_response.rb → afnor_webhook.rb} +55 -35
- data/lib/factpulse/models/{afnor_webhook_callback_content.rb → afnor_webhook_id_param.rb} +10 -11
- data/lib/factpulse/models/{afnor_legal_unit_payload_included_no_siren.rb → afnor_webhook_metadata.rb} +56 -33
- data/lib/factpulse/models/afnor_webhook_params.rb +190 -0
- data/lib/factpulse/models/{facture_electronique_rest_api_schemas_validation_validation_error_response.rb → afnor_webhook_patch_payload.rb} +29 -30
- data/lib/factpulse/models/afnoro_auth2_authentication.rb +216 -0
- data/lib/factpulse/models/chorus_pro_credentials.rb +94 -26
- data/lib/factpulse/models/chorus_pro_destination.rb +1 -1
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_cdar_validation_error_response.rb +215 -0
- data/lib/factpulse/models/{facture_electronique_models_invoice_type_code.rb → facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb} +9 -20
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +191 -0
- data/lib/factpulse/models/get_chorus_pro_id_request.rb +1 -1
- data/lib/factpulse/models/get_invoice_request.rb +1 -1
- data/lib/factpulse/models/get_structure_request.rb +1 -1
- data/lib/factpulse/models/invoice_input.rb +1 -1
- data/lib/factpulse/models/invoice_type_code.rb +17 -6
- data/lib/factpulse/models/processing_rule.rb +4 -1
- data/lib/factpulse/models/search_structure_request.rb +1 -1
- data/lib/factpulse/models/simplified_invoice_data.rb +1 -1
- data/lib/factpulse/models/submit_invoice_request.rb +1 -1
- data/lib/factpulse/models/validate_cdar_response.rb +2 -2
- data/lib/factpulse/models/validation_error_response.rb +20 -67
- data/lib/factpulse/version.rb +1 -1
- data/lib/factpulse.rb +25 -22
- metadata +52 -46
- data/docs/AFNORAddressEdit.md +0 -30
- data/docs/AFNORAddressPatch.md +0 -30
- data/docs/AFNORAddressPut.md +0 -30
- data/docs/AFNORCreateDirectoryLineBody.md +0 -20
- data/docs/AFNORCreateDirectoryLineBodyAddressingInformation.md +0 -24
- data/docs/AFNORCreateDirectoryLineBodyPeriod.md +0 -20
- data/docs/AFNORCreateRoutingCodeBody.md +0 -32
- data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform.md +0 -20
- data/docs/AFNORDirectoryLinePost201Response.md +0 -22
- data/docs/AFNORLegalUnitPayloadIncludedNoSiren.md +0 -22
- data/docs/AFNORRoutingCodePost201Response.md +0 -22
- data/docs/AFNORUpdatePatchDirectoryLineBody.md +0 -18
- data/docs/AFNORUpdatePatchRoutingCodeBody.md +0 -24
- data/docs/AFNORUpdatePutRoutingCodeBody.md +0 -24
- data/docs/AFNORWebhookCallbackContent.md +0 -18
- data/docs/FactureElectroniqueModelsInvoiceTypeCode.md +0 -15
- data/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +0 -26
- data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +0 -18
- data/lib/factpulse/models/afnor_address_edit.rb +0 -353
- data/lib/factpulse/models/afnor_address_patch.rb +0 -386
- data/lib/factpulse/models/afnor_address_put.rb +0 -435
- data/lib/factpulse/models/afnor_create_routing_code_body.rb +0 -412
- data/lib/factpulse/models/afnor_update_put_routing_code_body.rb +0 -289
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb +0 -259
|
@@ -4,10 +4,140 @@ All URIs are relative to *https://factpulse.fr*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_webhook_proxy_api_v1_afnor_flow_v1_webhooks_post**](AFNORPDPPAFlowServiceApi.md#create_webhook_proxy_api_v1_afnor_flow_v1_webhooks_post) | **POST** /api/v1/afnor/flow/v1/webhooks | Create a webhook |
|
|
8
|
+
| [**delete_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_delete**](AFNORPDPPAFlowServiceApi.md#delete_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_delete) | **DELETE** /api/v1/afnor/flow/v1/webhooks/{webhookUid} | Delete a webhook |
|
|
7
9
|
| [**download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get**](AFNORPDPPAFlowServiceApi.md#download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get) | **GET** /api/v1/afnor/flow/v1/flows/{flowId} | Download a flow |
|
|
8
10
|
| [**flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get**](AFNORPDPPAFlowServiceApi.md#flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get) | **GET** /api/v1/afnor/flow/v1/healthcheck | Healthcheck Flow Service |
|
|
11
|
+
| [**get_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_get**](AFNORPDPPAFlowServiceApi.md#get_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_get) | **GET** /api/v1/afnor/flow/v1/webhooks/{webhookUid} | Get a webhook |
|
|
12
|
+
| [**list_webhooks_proxy_api_v1_afnor_flow_v1_webhooks_get**](AFNORPDPPAFlowServiceApi.md#list_webhooks_proxy_api_v1_afnor_flow_v1_webhooks_get) | **GET** /api/v1/afnor/flow/v1/webhooks | List webhooks |
|
|
9
13
|
| [**search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post**](AFNORPDPPAFlowServiceApi.md#search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post) | **POST** /api/v1/afnor/flow/v1/flows/search | Search flows |
|
|
10
14
|
| [**submit_flow_proxy_api_v1_afnor_flow_v1_flows_post**](AFNORPDPPAFlowServiceApi.md#submit_flow_proxy_api_v1_afnor_flow_v1_flows_post) | **POST** /api/v1/afnor/flow/v1/flows | Submit an invoicing flow |
|
|
15
|
+
| [**update_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_patch**](AFNORPDPPAFlowServiceApi.md#update_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_patch) | **PATCH** /api/v1/afnor/flow/v1/webhooks/{webhookUid} | Update a webhook |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## create_webhook_proxy_api_v1_afnor_flow_v1_webhooks_post
|
|
19
|
+
|
|
20
|
+
> Object create_webhook_proxy_api_v1_afnor_flow_v1_webhooks_post
|
|
21
|
+
|
|
22
|
+
Create a webhook
|
|
23
|
+
|
|
24
|
+
Register a new webhook subscription (AFNOR XP Z12-013 v1.2.0)
|
|
25
|
+
|
|
26
|
+
### Examples
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'time'
|
|
30
|
+
require 'factpulse'
|
|
31
|
+
|
|
32
|
+
api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
|
|
33
|
+
|
|
34
|
+
begin
|
|
35
|
+
# Create a webhook
|
|
36
|
+
result = api_instance.create_webhook_proxy_api_v1_afnor_flow_v1_webhooks_post
|
|
37
|
+
p result
|
|
38
|
+
rescue FactPulse::ApiError => e
|
|
39
|
+
puts "Error when calling AFNORPDPPAFlowServiceApi->create_webhook_proxy_api_v1_afnor_flow_v1_webhooks_post: #{e}"
|
|
40
|
+
end
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
#### Using the create_webhook_proxy_api_v1_afnor_flow_v1_webhooks_post_with_http_info variant
|
|
44
|
+
|
|
45
|
+
This returns an Array which contains the response data, status code and headers.
|
|
46
|
+
|
|
47
|
+
> <Array(Object, Integer, Hash)> create_webhook_proxy_api_v1_afnor_flow_v1_webhooks_post_with_http_info
|
|
48
|
+
|
|
49
|
+
```ruby
|
|
50
|
+
begin
|
|
51
|
+
# Create a webhook
|
|
52
|
+
data, status_code, headers = api_instance.create_webhook_proxy_api_v1_afnor_flow_v1_webhooks_post_with_http_info
|
|
53
|
+
p status_code # => 2xx
|
|
54
|
+
p headers # => { ... }
|
|
55
|
+
p data # => Object
|
|
56
|
+
rescue FactPulse::ApiError => e
|
|
57
|
+
puts "Error when calling AFNORPDPPAFlowServiceApi->create_webhook_proxy_api_v1_afnor_flow_v1_webhooks_post_with_http_info: #{e}"
|
|
58
|
+
end
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
This endpoint does not need any parameter.
|
|
64
|
+
|
|
65
|
+
### Return type
|
|
66
|
+
|
|
67
|
+
**Object**
|
|
68
|
+
|
|
69
|
+
### Authorization
|
|
70
|
+
|
|
71
|
+
No authorization required
|
|
72
|
+
|
|
73
|
+
### HTTP request headers
|
|
74
|
+
|
|
75
|
+
- **Content-Type**: Not defined
|
|
76
|
+
- **Accept**: application/json
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
## delete_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_delete
|
|
80
|
+
|
|
81
|
+
> Object delete_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_delete(webhook_uid)
|
|
82
|
+
|
|
83
|
+
Delete a webhook
|
|
84
|
+
|
|
85
|
+
Delete a webhook subscription (AFNOR XP Z12-013 v1.2.0)
|
|
86
|
+
|
|
87
|
+
### Examples
|
|
88
|
+
|
|
89
|
+
```ruby
|
|
90
|
+
require 'time'
|
|
91
|
+
require 'factpulse'
|
|
92
|
+
|
|
93
|
+
api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
|
|
94
|
+
webhook_uid = 'webhook_uid_example' # String | Webhook unique identifier (UUID)
|
|
95
|
+
|
|
96
|
+
begin
|
|
97
|
+
# Delete a webhook
|
|
98
|
+
result = api_instance.delete_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_delete(webhook_uid)
|
|
99
|
+
p result
|
|
100
|
+
rescue FactPulse::ApiError => e
|
|
101
|
+
puts "Error when calling AFNORPDPPAFlowServiceApi->delete_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_delete: #{e}"
|
|
102
|
+
end
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
#### Using the delete_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_delete_with_http_info variant
|
|
106
|
+
|
|
107
|
+
This returns an Array which contains the response data, status code and headers.
|
|
108
|
+
|
|
109
|
+
> <Array(Object, Integer, Hash)> delete_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_delete_with_http_info(webhook_uid)
|
|
110
|
+
|
|
111
|
+
```ruby
|
|
112
|
+
begin
|
|
113
|
+
# Delete a webhook
|
|
114
|
+
data, status_code, headers = api_instance.delete_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_delete_with_http_info(webhook_uid)
|
|
115
|
+
p status_code # => 2xx
|
|
116
|
+
p headers # => { ... }
|
|
117
|
+
p data # => Object
|
|
118
|
+
rescue FactPulse::ApiError => e
|
|
119
|
+
puts "Error when calling AFNORPDPPAFlowServiceApi->delete_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_delete_with_http_info: #{e}"
|
|
120
|
+
end
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Parameters
|
|
124
|
+
|
|
125
|
+
| Name | Type | Description | Notes |
|
|
126
|
+
| ---- | ---- | ----------- | ----- |
|
|
127
|
+
| **webhook_uid** | **String** | Webhook unique identifier (UUID) | |
|
|
128
|
+
|
|
129
|
+
### Return type
|
|
130
|
+
|
|
131
|
+
**Object**
|
|
132
|
+
|
|
133
|
+
### Authorization
|
|
134
|
+
|
|
135
|
+
No authorization required
|
|
136
|
+
|
|
137
|
+
### HTTP request headers
|
|
138
|
+
|
|
139
|
+
- **Content-Type**: Not defined
|
|
140
|
+
- **Accept**: application/json
|
|
11
141
|
|
|
12
142
|
|
|
13
143
|
## download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get
|
|
@@ -139,6 +269,131 @@ No authorization required
|
|
|
139
269
|
- **Accept**: application/json
|
|
140
270
|
|
|
141
271
|
|
|
272
|
+
## get_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_get
|
|
273
|
+
|
|
274
|
+
> <AFNORWebhook> get_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_get(webhook_uid)
|
|
275
|
+
|
|
276
|
+
Get a webhook
|
|
277
|
+
|
|
278
|
+
Get details of a specific webhook (AFNOR XP Z12-013 v1.2.0)
|
|
279
|
+
|
|
280
|
+
### Examples
|
|
281
|
+
|
|
282
|
+
```ruby
|
|
283
|
+
require 'time'
|
|
284
|
+
require 'factpulse'
|
|
285
|
+
|
|
286
|
+
api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
|
|
287
|
+
webhook_uid = 'webhook_uid_example' # String | Webhook unique identifier (UUID)
|
|
288
|
+
|
|
289
|
+
begin
|
|
290
|
+
# Get a webhook
|
|
291
|
+
result = api_instance.get_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_get(webhook_uid)
|
|
292
|
+
p result
|
|
293
|
+
rescue FactPulse::ApiError => e
|
|
294
|
+
puts "Error when calling AFNORPDPPAFlowServiceApi->get_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_get: #{e}"
|
|
295
|
+
end
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
#### Using the get_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_get_with_http_info variant
|
|
299
|
+
|
|
300
|
+
This returns an Array which contains the response data, status code and headers.
|
|
301
|
+
|
|
302
|
+
> <Array(<AFNORWebhook>, Integer, Hash)> get_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_get_with_http_info(webhook_uid)
|
|
303
|
+
|
|
304
|
+
```ruby
|
|
305
|
+
begin
|
|
306
|
+
# Get a webhook
|
|
307
|
+
data, status_code, headers = api_instance.get_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_get_with_http_info(webhook_uid)
|
|
308
|
+
p status_code # => 2xx
|
|
309
|
+
p headers # => { ... }
|
|
310
|
+
p data # => <AFNORWebhook>
|
|
311
|
+
rescue FactPulse::ApiError => e
|
|
312
|
+
puts "Error when calling AFNORPDPPAFlowServiceApi->get_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_get_with_http_info: #{e}"
|
|
313
|
+
end
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
### Parameters
|
|
317
|
+
|
|
318
|
+
| Name | Type | Description | Notes |
|
|
319
|
+
| ---- | ---- | ----------- | ----- |
|
|
320
|
+
| **webhook_uid** | **String** | Webhook unique identifier (UUID) | |
|
|
321
|
+
|
|
322
|
+
### Return type
|
|
323
|
+
|
|
324
|
+
[**AFNORWebhook**](AFNORWebhook.md)
|
|
325
|
+
|
|
326
|
+
### Authorization
|
|
327
|
+
|
|
328
|
+
No authorization required
|
|
329
|
+
|
|
330
|
+
### HTTP request headers
|
|
331
|
+
|
|
332
|
+
- **Content-Type**: Not defined
|
|
333
|
+
- **Accept**: application/json
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
## list_webhooks_proxy_api_v1_afnor_flow_v1_webhooks_get
|
|
337
|
+
|
|
338
|
+
> <Array<AFNORWebhook>> list_webhooks_proxy_api_v1_afnor_flow_v1_webhooks_get
|
|
339
|
+
|
|
340
|
+
List webhooks
|
|
341
|
+
|
|
342
|
+
List all registered webhooks (AFNOR XP Z12-013 v1.2.0)
|
|
343
|
+
|
|
344
|
+
### Examples
|
|
345
|
+
|
|
346
|
+
```ruby
|
|
347
|
+
require 'time'
|
|
348
|
+
require 'factpulse'
|
|
349
|
+
|
|
350
|
+
api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
|
|
351
|
+
|
|
352
|
+
begin
|
|
353
|
+
# List webhooks
|
|
354
|
+
result = api_instance.list_webhooks_proxy_api_v1_afnor_flow_v1_webhooks_get
|
|
355
|
+
p result
|
|
356
|
+
rescue FactPulse::ApiError => e
|
|
357
|
+
puts "Error when calling AFNORPDPPAFlowServiceApi->list_webhooks_proxy_api_v1_afnor_flow_v1_webhooks_get: #{e}"
|
|
358
|
+
end
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
#### Using the list_webhooks_proxy_api_v1_afnor_flow_v1_webhooks_get_with_http_info variant
|
|
362
|
+
|
|
363
|
+
This returns an Array which contains the response data, status code and headers.
|
|
364
|
+
|
|
365
|
+
> <Array(<Array<AFNORWebhook>>, Integer, Hash)> list_webhooks_proxy_api_v1_afnor_flow_v1_webhooks_get_with_http_info
|
|
366
|
+
|
|
367
|
+
```ruby
|
|
368
|
+
begin
|
|
369
|
+
# List webhooks
|
|
370
|
+
data, status_code, headers = api_instance.list_webhooks_proxy_api_v1_afnor_flow_v1_webhooks_get_with_http_info
|
|
371
|
+
p status_code # => 2xx
|
|
372
|
+
p headers # => { ... }
|
|
373
|
+
p data # => <Array<AFNORWebhook>>
|
|
374
|
+
rescue FactPulse::ApiError => e
|
|
375
|
+
puts "Error when calling AFNORPDPPAFlowServiceApi->list_webhooks_proxy_api_v1_afnor_flow_v1_webhooks_get_with_http_info: #{e}"
|
|
376
|
+
end
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### Parameters
|
|
380
|
+
|
|
381
|
+
This endpoint does not need any parameter.
|
|
382
|
+
|
|
383
|
+
### Return type
|
|
384
|
+
|
|
385
|
+
[**Array<AFNORWebhook>**](AFNORWebhook.md)
|
|
386
|
+
|
|
387
|
+
### Authorization
|
|
388
|
+
|
|
389
|
+
No authorization required
|
|
390
|
+
|
|
391
|
+
### HTTP request headers
|
|
392
|
+
|
|
393
|
+
- **Content-Type**: Not defined
|
|
394
|
+
- **Accept**: application/json
|
|
395
|
+
|
|
396
|
+
|
|
142
397
|
## search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post
|
|
143
398
|
|
|
144
399
|
> <AFNORSearchFlowContent> search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post(afnor_search_flow_params)
|
|
@@ -218,7 +473,7 @@ require 'time'
|
|
|
218
473
|
require 'factpulse'
|
|
219
474
|
|
|
220
475
|
api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
|
|
221
|
-
flow_info = FactPulse::AFNORFlowInfo.new({flow_syntax: FactPulse::AFNORFlowSyntax::CII}) # AFNORFlowInfo |
|
|
476
|
+
flow_info = FactPulse::AFNORFlowInfo.new({name: 'name_example', flow_syntax: FactPulse::AFNORFlowSyntax::CII}) # AFNORFlowInfo |
|
|
222
477
|
file = File.new('/path/to/some/file') # File | Flow file (PDF/A-3 with embedded XML or XML)
|
|
223
478
|
|
|
224
479
|
begin
|
|
@@ -268,3 +523,67 @@ No authorization required
|
|
|
268
523
|
- **Content-Type**: multipart/form-data
|
|
269
524
|
- **Accept**: application/json
|
|
270
525
|
|
|
526
|
+
|
|
527
|
+
## update_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_patch
|
|
528
|
+
|
|
529
|
+
> <AFNORWebhook> update_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_patch(webhook_uid)
|
|
530
|
+
|
|
531
|
+
Update a webhook
|
|
532
|
+
|
|
533
|
+
Partially update a webhook subscription (AFNOR XP Z12-013 v1.2.0)
|
|
534
|
+
|
|
535
|
+
### Examples
|
|
536
|
+
|
|
537
|
+
```ruby
|
|
538
|
+
require 'time'
|
|
539
|
+
require 'factpulse'
|
|
540
|
+
|
|
541
|
+
api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
|
|
542
|
+
webhook_uid = 'webhook_uid_example' # String | Webhook unique identifier (UUID)
|
|
543
|
+
|
|
544
|
+
begin
|
|
545
|
+
# Update a webhook
|
|
546
|
+
result = api_instance.update_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_patch(webhook_uid)
|
|
547
|
+
p result
|
|
548
|
+
rescue FactPulse::ApiError => e
|
|
549
|
+
puts "Error when calling AFNORPDPPAFlowServiceApi->update_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_patch: #{e}"
|
|
550
|
+
end
|
|
551
|
+
```
|
|
552
|
+
|
|
553
|
+
#### Using the update_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_patch_with_http_info variant
|
|
554
|
+
|
|
555
|
+
This returns an Array which contains the response data, status code and headers.
|
|
556
|
+
|
|
557
|
+
> <Array(<AFNORWebhook>, Integer, Hash)> update_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_patch_with_http_info(webhook_uid)
|
|
558
|
+
|
|
559
|
+
```ruby
|
|
560
|
+
begin
|
|
561
|
+
# Update a webhook
|
|
562
|
+
data, status_code, headers = api_instance.update_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_patch_with_http_info(webhook_uid)
|
|
563
|
+
p status_code # => 2xx
|
|
564
|
+
p headers # => { ... }
|
|
565
|
+
p data # => <AFNORWebhook>
|
|
566
|
+
rescue FactPulse::ApiError => e
|
|
567
|
+
puts "Error when calling AFNORPDPPAFlowServiceApi->update_webhook_proxy_api_v1_afnor_flow_v1_webhooks_webhook_uid_patch_with_http_info: #{e}"
|
|
568
|
+
end
|
|
569
|
+
```
|
|
570
|
+
|
|
571
|
+
### Parameters
|
|
572
|
+
|
|
573
|
+
| Name | Type | Description | Notes |
|
|
574
|
+
| ---- | ---- | ----------- | ----- |
|
|
575
|
+
| **webhook_uid** | **String** | Webhook unique identifier (UUID) | |
|
|
576
|
+
|
|
577
|
+
### Return type
|
|
578
|
+
|
|
579
|
+
[**AFNORWebhook**](AFNORWebhook.md)
|
|
580
|
+
|
|
581
|
+
### Authorization
|
|
582
|
+
|
|
583
|
+
No authorization required
|
|
584
|
+
|
|
585
|
+
### HTTP request headers
|
|
586
|
+
|
|
587
|
+
- **Content-Type**: Not defined
|
|
588
|
+
- **Accept**: application/json
|
|
589
|
+
|
|
@@ -19,7 +19,7 @@ require 'factpulse'
|
|
|
19
19
|
instance = FactPulse::AFNORRoutingCodeSearch.new(
|
|
20
20
|
filters: null,
|
|
21
21
|
sorting: [{field=siret, order=ascendant}, {field=routingIdentifier, order=ascendant}],
|
|
22
|
-
fields: [siret, routingIdentifierType, routingCodeName, routingIdentifier, managesLegalCommitmentCode, administrativeStatus, address
|
|
22
|
+
fields: [siret, routingIdentifierType, routingCodeName, routingIdentifier, managesLegalCommitmentCode, administrativeStatus, address],
|
|
23
23
|
include: [siren, siret],
|
|
24
24
|
limit: 50,
|
|
25
25
|
ignore: 20
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORContainsOrStrictOperator**](AFNORContainsOrStrictOperator.md) | | [optional] |
|
|
8
8
|
| **value** | **String** | Name of the routing code. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORContainsOrStrictOperator**](AFNORContainsOrStrictOperator.md) | | [optional] |
|
|
8
8
|
| **value** | **String** | Routing identifier for a routing code. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -17,8 +17,8 @@ require 'factpulse'
|
|
|
17
17
|
|
|
18
18
|
instance = FactPulse::AFNORSearchDirectoryLine.new(
|
|
19
19
|
filters: null,
|
|
20
|
-
sorting: [{
|
|
21
|
-
fields: [addressingIdentifier, siren, siret, addressingSuffix
|
|
20
|
+
sorting: [{field=addressingIdentifier, order=ascending}],
|
|
21
|
+
fields: [addressingIdentifier, siren, siret, addressingSuffix],
|
|
22
22
|
limit: 50,
|
|
23
23
|
ignore: 20
|
|
24
24
|
)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORContainsOrStrictOperator**](AFNORContainsOrStrictOperator.md) | | [optional] |
|
|
8
8
|
| **value** | **String** | Addressing identifier of the directory line. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORContainsOrStrictOperator**](AFNORContainsOrStrictOperator.md) | | [optional] |
|
|
8
8
|
| **value** | **String** | suffix of the directory line which defines an address mesh not attached to a facility | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **updated_after** | **Time** |
|
|
7
|
+
| **updated_after** | **Time** | The comparison with current date is strict : updatedAt > updatedAfter | [optional] |
|
|
8
8
|
| **updated_before** | **Time** | | [optional] |
|
|
9
9
|
| **processing_rule** | [**Array<AFNORProcessingRule>**](AFNORProcessingRule.md) | | [optional] |
|
|
10
10
|
| **flow_type** | [**Array<AFNORFlowType>**](AFNORFlowType.md) | | [optional] |
|
data/docs/AFNORSearchSiren.md
CHANGED
|
@@ -18,7 +18,7 @@ require 'factpulse'
|
|
|
18
18
|
instance = FactPulse::AFNORSearchSiren.new(
|
|
19
19
|
filters: null,
|
|
20
20
|
sorting: [{field=siren, order=ascending}, {field=administrativeStatus, order=descending}],
|
|
21
|
-
fields: [siren, businessName, entityType, administrativeStatus,
|
|
21
|
+
fields: [siren, businessName, entityType, administrativeStatus, instructions],
|
|
22
22
|
limit: 50,
|
|
23
23
|
ignore: 20
|
|
24
24
|
)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORContainsOrStrictOperator**](AFNORContainsOrStrictOperator.md) | | [optional] |
|
|
8
8
|
| **value** | **String** | Business name | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORStrictOperator**](AFNORStrictOperator.md) | | [optional] |
|
|
8
8
|
| **value** | **String** | SIREN number to search for. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
data/docs/AFNORSearchSiret.md
CHANGED
|
@@ -18,8 +18,8 @@ require 'factpulse'
|
|
|
18
18
|
|
|
19
19
|
instance = FactPulse::AFNORSearchSiret.new(
|
|
20
20
|
filters: null,
|
|
21
|
-
sorting: [{
|
|
22
|
-
fields: [siret, siren, name, facilityType,
|
|
21
|
+
sorting: [{field=siret, order=ascending}, {field=name, order=descending}],
|
|
22
|
+
fields: [siret, siren, name, facilityType, administrativeStatus, siretInstructions, address, pmStatus, pmOnly, managesPaymentStatus, managesLegalCommitment, managesLegalCommitmentOrService, serviceCodeStatus],
|
|
23
23
|
include: [siren],
|
|
24
24
|
limit: 50,
|
|
25
25
|
ignore: 20
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORStrictOperator**](AFNORStrictOperator.md) | | [optional] |
|
|
8
8
|
| **value** | **String** | Subdivision of the country | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORStrictOperator**](AFNORStrictOperator.md) | | [optional] |
|
|
8
8
|
| **value** | [**AFNORFacilityType**](AFNORFacilityType.md) | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORContainsOrStrictOperator**](AFNORContainsOrStrictOperator.md) | | [optional] |
|
|
8
8
|
| **value** | **String** | Municipality of the recipient structure having defined the directory line(s). | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORContainsOrStrictOperator**](AFNORContainsOrStrictOperator.md) | | [optional] |
|
|
8
8
|
| **value** | **String** | business name | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORStrictOrStartWithOperator**](AFNORStrictOrStartWithOperator.md) | | [optional] |
|
|
8
8
|
| **value** | **String** | Service postal code | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **op** | [**
|
|
7
|
+
| **op** | [**AFNORStrictOperator**](AFNORStrictOperator.md) | | [optional] |
|
|
8
8
|
| **value** | **String** | SIRET number to search for. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FactPulse::AFNORSirenInstructions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **is_sales_prospecting_forbidden** | **Boolean** | Indicates whether the information is forbidden from being used for sales prospecting purposes. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'factpulse'
|
|
13
|
+
|
|
14
|
+
instance = FactPulse::AFNORSirenInstructions.new(
|
|
15
|
+
is_sales_prospecting_forbidden: false
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FactPulse::AFNORSiretInstructions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **is_sales_prospecting_forbidden** | **Boolean** | Indicates whether the information is forbidden from being used for sales prospecting purposes. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'factpulse'
|
|
13
|
+
|
|
14
|
+
instance = FactPulse::AFNORSiretInstructions.new(
|
|
15
|
+
is_sales_prospecting_forbidden: false
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FactPulse::
|
|
1
|
+
# FactPulse::AFNORStrictOrStartWithOperator
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
```ruby
|
|
11
11
|
require 'factpulse'
|
|
12
12
|
|
|
13
|
-
instance = FactPulse::
|
|
13
|
+
instance = FactPulse::AFNORStrictOrStartWithOperator.new()
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FactPulse::AFNORWebhook
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **webhook_id** | **String** | | [optional] |
|
|
8
|
+
| **callback** | [**AFNORCallbackParameters**](AFNORCallbackParameters.md) | | |
|
|
9
|
+
| **metadata** | [**AFNORWebhookMetadata**](AFNORWebhookMetadata.md) | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'factpulse'
|
|
15
|
+
|
|
16
|
+
instance = FactPulse::AFNORWebhook.new(
|
|
17
|
+
webhook_id: null,
|
|
18
|
+
callback: null,
|
|
19
|
+
metadata: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FactPulse::AFNORWebhookIdParam
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **webhook_id** | **String** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'factpulse'
|
|
13
|
+
|
|
14
|
+
instance = FactPulse::AFNORWebhookIdParam.new(
|
|
15
|
+
webhook_id: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# FactPulse::AFNORWebhookMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **processing_rule** | [**AFNORProcessingRule**](AFNORProcessingRule.md) | | [optional] |
|
|
8
|
+
| **flow_type** | [**AFNORFlowType**](AFNORFlowType.md) | | |
|
|
9
|
+
| **flow_direction** | [**AFNORFlowDirection**](AFNORFlowDirection.md) | | |
|
|
10
|
+
| **ack_status** | [**AFNORFlowAckStatus**](AFNORFlowAckStatus.md) | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'factpulse'
|
|
16
|
+
|
|
17
|
+
instance = FactPulse::AFNORWebhookMetadata.new(
|
|
18
|
+
processing_rule: null,
|
|
19
|
+
flow_type: null,
|
|
20
|
+
flow_direction: null,
|
|
21
|
+
ack_status: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# FactPulse::AFNORWebhookParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **callback** | [**AFNORCallbackParameters**](AFNORCallbackParameters.md) | | |
|
|
8
|
+
| **metadata** | [**AFNORWebhookMetadata**](AFNORWebhookMetadata.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'factpulse'
|
|
14
|
+
|
|
15
|
+
instance = FactPulse::AFNORWebhookParams.new(
|
|
16
|
+
callback: null,
|
|
17
|
+
metadata: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|