Skip to content

Commit 184b88f

Browse files
m-houstonm-houston
committed
CCM-8855: Update generated client libs
1 parent 4118582 commit 184b88f

File tree

113 files changed

+2580
-5787
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+2580
-5787
lines changed

‎.gitleaksignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,7 @@ cd9c0efec38c5d63053dd865e5d4e207c0760d91:docs/guides/Perform_static_analysis.md:
66
4f4e8c15629b2cb09356a7fed4d72953590227ce:docs/Gemfile.lock:ipv4:4
77
b1f85a7faf54eaf66074d7a6daa093aefe6b3ebe:sdk/python/test-requirements.txt:ipv4:5
88
b1f85a7faf54eaf66074d7a6daa093aefe6b3ebe:sdk/python/pyproject.toml:ipv4:25
9+
10+
# Example ECDA key in OAPI spec
11+
4118582e5009685c1ac31fc664371649602a8a0e:specification/api/notify-supplier.yml:generic-api-key:115
12+
4118582e5009685c1ac31fc664371649602a8a0e:specification/api/notify-supplier-next.yml:generic-api-key:119

‎sdk/python/.openapi-generator/FILES‎

Lines changed: 39 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,74 @@
11
.github/workflows/python.yml
22
.gitignore
33
.gitlab-ci.yml
4-
.openapi-generator-ignore
54
.travis.yml
65
README.md
7-
docs/ArtworkApi.md
6+
docs/Batch.md
87
docs/BatchApi.md
98
docs/BatchResponse.md
109
docs/BatchResponseData.md
11-
docs/BatchResponseDataAttributes.md
10+
docs/BatchStatus.md
11+
docs/BatchUpdateData.md
12+
docs/BatchUpdateDataData.md
13+
docs/BatchUpdateDataDataAttributes.md
1214
docs/DataApi.md
13-
docs/Download.md
15+
docs/DataReference.md
1416
docs/ErrorData.md
1517
docs/ErrorItem.md
1618
docs/ErrorItemLinks.md
1719
docs/ErrorResponse.md
20+
docs/GetBatches200Response.md
21+
docs/GetBatches200ResponseDataInner.md
22+
docs/GetBatches200ResponseLinks.md
1823
docs/Letter.md
1924
docs/LetterApi.md
20-
docs/LetterBatchUpdateData.md
21-
docs/LetterBatchUpdateDataData.md
22-
docs/LetterBatchUpdateDataDataAttributes.md
2325
docs/LetterStatus.md
2426
docs/LetterStatusData.md
2527
docs/LetterStatusDataData.md
2628
docs/LetterStatusDataDataAttributes.md
2729
docs/LetterUpdateData.md
30+
docs/LetterUpdateDataData.md
31+
docs/LetterUpdateDataDataAttributes.md
2832
docs/MiApi.md
29-
docs/ProofApi.md
30-
docs/ReturnApi.md
31-
docs/SpecificationApi.md
33+
docs/ProductionStatus.md
34+
docs/WhitemailApi.md
3235
git_push.sh
3336
openapi_client/__init__.py
3437
openapi_client/api/__init__.py
35-
openapi_client/api/artwork_api.py
3638
openapi_client/api/batch_api.py
3739
openapi_client/api/data_api.py
3840
openapi_client/api/letter_api.py
3941
openapi_client/api/mi_api.py
40-
openapi_client/api/proof_api.py
41-
openapi_client/api/return_api.py
42-
openapi_client/api/specification_api.py
42+
openapi_client/api/whitemail_api.py
4343
openapi_client/api_client.py
4444
openapi_client/api_response.py
4545
openapi_client/configuration.py
4646
openapi_client/exceptions.py
4747
openapi_client/models/__init__.py
48+
openapi_client/models/batch.py
4849
openapi_client/models/batch_response.py
4950
openapi_client/models/batch_response_data.py
50-
openapi_client/models/batch_response_data_attributes.py
51-
openapi_client/models/download.py
51+
openapi_client/models/batch_status.py
52+
openapi_client/models/batch_update_data.py
53+
openapi_client/models/batch_update_data_data.py
54+
openapi_client/models/batch_update_data_data_attributes.py
55+
openapi_client/models/data_reference.py
5256
openapi_client/models/error_data.py
5357
openapi_client/models/error_item.py
5458
openapi_client/models/error_item_links.py
5559
openapi_client/models/error_response.py
60+
openapi_client/models/get_batches200_response.py
61+
openapi_client/models/get_batches200_response_data_inner.py
62+
openapi_client/models/get_batches200_response_links.py
5663
openapi_client/models/letter.py
57-
openapi_client/models/letter_batch_update_data.py
58-
openapi_client/models/letter_batch_update_data_data.py
59-
openapi_client/models/letter_batch_update_data_data_attributes.py
6064
openapi_client/models/letter_status.py
6165
openapi_client/models/letter_status_data.py
6266
openapi_client/models/letter_status_data_data.py
6367
openapi_client/models/letter_status_data_data_attributes.py
6468
openapi_client/models/letter_update_data.py
69+
openapi_client/models/letter_update_data_data.py
70+
openapi_client/models/letter_update_data_data_attributes.py
71+
openapi_client/models/production_status.py
6572
openapi_client/py.typed
6673
openapi_client/rest.py
6774
pyproject.toml
@@ -70,29 +77,33 @@ setup.cfg
7077
setup.py
7178
test-requirements.txt
7279
test/__init__.py
73-
test/test_artwork_api.py
80+
test/test_batch.py
7481
test/test_batch_api.py
7582
test/test_batch_response.py
7683
test/test_batch_response_data.py
77-
test/test_batch_response_data_attributes.py
84+
test/test_batch_status.py
85+
test/test_batch_update_data.py
86+
test/test_batch_update_data_data.py
87+
test/test_batch_update_data_data_attributes.py
7888
test/test_data_api.py
79-
test/test_download.py
89+
test/test_data_reference.py
8090
test/test_error_data.py
8191
test/test_error_item.py
8292
test/test_error_item_links.py
8393
test/test_error_response.py
94+
test/test_get_batches200_response.py
95+
test/test_get_batches200_response_data_inner.py
96+
test/test_get_batches200_response_links.py
8497
test/test_letter.py
8598
test/test_letter_api.py
86-
test/test_letter_batch_update_data.py
87-
test/test_letter_batch_update_data_data.py
88-
test/test_letter_batch_update_data_data_attributes.py
8999
test/test_letter_status.py
90100
test/test_letter_status_data.py
91101
test/test_letter_status_data_data.py
92102
test/test_letter_status_data_data_attributes.py
93103
test/test_letter_update_data.py
104+
test/test_letter_update_data_data.py
105+
test/test_letter_update_data_data_attributes.py
94106
test/test_mi_api.py
95-
test/test_proof_api.py
96-
test/test_return_api.py
97-
test/test_specification_api.py
107+
test/test_production_status.py
108+
test/test_whitemail_api.py
98109
tox.ini

‎sdk/python/README.md‎

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ API for communication suppliers to integrate with NHS Notify
33

44
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

6-
- API version: 0.0.1
6+
- API version: 0.1.0
77
- Package version: 1.0.0
88
- Generator version: 7.13.0-SNAPSHOT
99
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
@@ -72,15 +72,18 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
7272
# Enter a context with an instance of the API client
7373
with openapi_client.ApiClient(configuration) as api_client:
7474
# Create an instance of the API class
75-
api_instance = openapi_client.ArtworkApi(api_client)
75+
api_instance = openapi_client.BatchApi(api_client)
76+
id = 'id_example' # str | Unique identifier of this resource
7677
x_request_id = 'x_request_id_example' # str | Unique request identifier, in the format of a GUID
7778
x_correlation_id = 'x_correlation_id_example' # str | An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
7879

7980
try:
80-
# Create a new artwork metadata record
81-
api_instance.create_artwork(x_request_id, x_correlation_id=x_correlation_id)
81+
# Retrieve a batch of letters
82+
api_response = api_instance.get_batch_id(id, x_request_id, x_correlation_id=x_correlation_id)
83+
print("The response of BatchApi->get_batch_id:\n")
84+
pprint(api_response)
8285
except ApiException as e:
83-
print("Exception when calling ArtworkApi->create_artwork: %s\n" % e)
86+
print("Exception when calling BatchApi->get_batch_id: %s\n" % e)
8487

8588
```
8689

@@ -90,14 +93,11 @@ All URIs are relative to *http://127.0.0.1:3000*
9093

9194
Class | Method | HTTP request | Description
9295
------------ | ------------- | ------------- | -------------
93-
*ArtworkApi* | [**create_artwork**](docs/ArtworkApi.md#create_artwork) | **POST** /artwork | Create a new artwork metadata record
94-
*ArtworkApi* | [**get_artwork**](docs/ArtworkApi.md#get_artwork) | **GET** /artwork/{id} | Fetch metadata about a specific artwork file
95-
*ArtworkApi* | [**list_artwork**](docs/ArtworkApi.md#list_artwork) | **GET** /artwork | List artwork files
96-
*ArtworkApi* | [**patch_artwork**](docs/ArtworkApi.md#patch_artwork) | **PATCH** /artwork/{id} | Update metadata about a specific artwork file
9796
*BatchApi* | [**get_batch_id**](docs/BatchApi.md#get_batch_id) | **GET** /batch/{id} | Retrieve a batch of letters
9897
*BatchApi* | [**get_batches**](docs/BatchApi.md#get_batches) | **GET** /batch | Retrieve a list of available letter batches
9998
*BatchApi* | [**patch_letters_batch**](docs/BatchApi.md#patch_letters_batch) | **PATCH** /batch/{id} | Update the status of a batch of letters
100-
*DataApi* | [**get_data**](docs/DataApi.md#get_data) | **GET** /data/{id} | Fetch metadata about an existing data file
99+
*DataApi* | [**get_data_id**](docs/DataApi.md#get_data_id) | **GET** /data/{id} | Fetch a data file
100+
*DataApi* | [**head_data_id**](docs/DataApi.md#head_data_id) | **HEAD** /data/{id} | Fetch data file metadata
101101
*DataApi* | [**post_data**](docs/DataApi.md#post_data) | **POST** /data | Request a URL to upload a new data file
102102
*LetterApi* | [**get_a_list_of_letters**](docs/LetterApi.md#get_a_list_of_letters) | **GET** /letter | Get a list of letters
103103
*LetterApi* | [**get_letter_status**](docs/LetterApi.md#get_letter_status) | **GET** /letter/{id} | Retrieve the status of a letter
@@ -106,38 +106,37 @@ Class | Method | HTTP request | Description
106106
*MiApi* | [**create_mi**](docs/MiApi.md#create_mi) | **POST** /mi | Create a new MI record
107107
*MiApi* | [**get_mi**](docs/MiApi.md#get_mi) | **GET** /mi/{id} | Fetch a specific MI record
108108
*MiApi* | [**list_mi**](docs/MiApi.md#list_mi) | **GET** /mi | List MI records
109-
*ProofApi* | [**create_proof**](docs/ProofApi.md#create_proof) | **POST** /proof | Create a new proof metadata record
110-
*ProofApi* | [**get_proof**](docs/ProofApi.md#get_proof) | **GET** /proof/{id} | Fetch metadata about a specific proof file
111-
*ProofApi* | [**list_proof**](docs/ProofApi.md#list_proof) | **GET** /proof | List proof files
112-
*ProofApi* | [**patch_proof**](docs/ProofApi.md#patch_proof) | **PATCH** /proof/{id} | Update metadata about a specific proof file
113-
*ReturnApi* | [**create_return**](docs/ReturnApi.md#create_return) | **POST** /return | Create a new returned letter batch
114-
*ReturnApi* | [**get_return**](docs/ReturnApi.md#get_return) | **GET** /return/{id} | Fetch metadata about a specific return batch
115-
*ReturnApi* | [**list_return**](docs/ReturnApi.md#list_return) | **GET** /return | List batches of returned letters
116-
*SpecificationApi* | [**create_specification**](docs/SpecificationApi.md#create_specification) | **POST** /specification | Create a new specification record
117-
*SpecificationApi* | [**get_specification**](docs/SpecificationApi.md#get_specification) | **GET** /specification/{id} | Fetch metadata about a specific specification
118-
*SpecificationApi* | [**list_specification**](docs/SpecificationApi.md#list_specification) | **GET** /specification | List specifications
119-
*SpecificationApi* | [**patch_specification**](docs/SpecificationApi.md#patch_specification) | **PATCH** /specification/{id} | Update metadata about a specific specification
109+
*WhitemailApi* | [**create_whitemail**](docs/WhitemailApi.md#create_whitemail) | **POST** /whitemail | Create a new whitemail letter batch
110+
*WhitemailApi* | [**get_whitemail**](docs/WhitemailApi.md#get_whitemail) | **GET** /whitemail/{id} | Fetch metadata about a specific whitemail batch
111+
*WhitemailApi* | [**list_whitemail**](docs/WhitemailApi.md#list_whitemail) | **GET** /whitemail | List batches of whitemail letters
120112

121113

122114
## Documentation For Models
123115

116+
- [Batch](docs/Batch.md)
124117
- [BatchResponse](docs/BatchResponse.md)
125118
- [BatchResponseData](docs/BatchResponseData.md)
126-
- [BatchResponseDataAttributes](docs/BatchResponseDataAttributes.md)
127-
- [Download](docs/Download.md)
119+
- [BatchStatus](docs/BatchStatus.md)
120+
- [BatchUpdateData](docs/BatchUpdateData.md)
121+
- [BatchUpdateDataData](docs/BatchUpdateDataData.md)
122+
- [BatchUpdateDataDataAttributes](docs/BatchUpdateDataDataAttributes.md)
123+
- [DataReference](docs/DataReference.md)
128124
- [ErrorData](docs/ErrorData.md)
129125
- [ErrorItem](docs/ErrorItem.md)
130126
- [ErrorItemLinks](docs/ErrorItemLinks.md)
131127
- [ErrorResponse](docs/ErrorResponse.md)
128+
- [GetBatches200Response](docs/GetBatches200Response.md)
129+
- [GetBatches200ResponseDataInner](docs/GetBatches200ResponseDataInner.md)
130+
- [GetBatches200ResponseLinks](docs/GetBatches200ResponseLinks.md)
132131
- [Letter](docs/Letter.md)
133-
- [LetterBatchUpdateData](docs/LetterBatchUpdateData.md)
134-
- [LetterBatchUpdateDataData](docs/LetterBatchUpdateDataData.md)
135-
- [LetterBatchUpdateDataDataAttributes](docs/LetterBatchUpdateDataDataAttributes.md)
136132
- [LetterStatus](docs/LetterStatus.md)
137133
- [LetterStatusData](docs/LetterStatusData.md)
138134
- [LetterStatusDataData](docs/LetterStatusDataData.md)
139135
- [LetterStatusDataDataAttributes](docs/LetterStatusDataDataAttributes.md)
140136
- [LetterUpdateData](docs/LetterUpdateData.md)
137+
- [LetterUpdateDataData](docs/LetterUpdateDataData.md)
138+
- [LetterUpdateDataDataAttributes](docs/LetterUpdateDataDataAttributes.md)
139+
- [ProductionStatus](docs/ProductionStatus.md)
141140

142141

143142
<a id="documentation-for-authorization"></a>
@@ -150,12 +149,8 @@ Authentication schemes defined for the API:
150149

151150
- **Type**: OAuth
152151
- **Flow**: accessCode
153-
- **Authorization URL**:
152+
- **Authorization URL**:
154153
- **Scopes**: N/A
155154

156155

157156
## Author
158-
159-
160-
161-

0 commit comments

Comments
 (0)