ofsc 2.26.2__tar.gz → 2.27.0__tar.gz

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.
Files changed (144) hide show
  1. ofsc-2.27.0/.github/workflows/publish.yml +47 -0
  2. ofsc-2.27.0/AGENTS.md +11 -0
  3. {ofsc-2.26.2 → ofsc-2.27.0}/CONTRIBUTING.md +24 -13
  4. {ofsc-2.26.2 → ofsc-2.27.0}/PKG-INFO +66 -3
  5. {ofsc-2.26.2 → ofsc-2.27.0}/README.md +64 -1
  6. {ofsc-2.26.2 → ofsc-2.27.0}/docs/ENDPOINTS.md +10 -10
  7. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/_base.py +3 -3
  8. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/core/_base.py +169 -13
  9. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/core.py +35 -0
  10. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/models/__init__.py +1 -1
  11. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/models/_base.py +0 -1
  12. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/models/metadata.py +3 -1
  13. {ofsc-2.26.2 → ofsc-2.27.0}/pyproject.toml +2 -2
  14. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_base_helpers.py +30 -1
  15. ofsc-2.27.0/tests/async/test_async_core_actions.py +196 -0
  16. ofsc-2.27.0/tests/async/test_async_core_collection_helpers.py +190 -0
  17. ofsc-2.27.0/tests/async/test_async_daily_extract_stream.py +215 -0
  18. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_metadata_write.py +8 -2
  19. ofsc-2.27.0/tests/async/test_capacity_category_name.py +65 -0
  20. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_properties.py +14 -0
  21. ofsc-2.27.0/tests/test_call_headers.py +96 -0
  22. {ofsc-2.26.2 → ofsc-2.27.0}/tests/test_model.py +21 -0
  23. ofsc-2.27.0/tests/test_sync_daily_extract_stream.py +251 -0
  24. {ofsc-2.26.2 → ofsc-2.27.0}/uv.lock +80 -68
  25. {ofsc-2.26.2 → ofsc-2.27.0}/.gitattributes +0 -0
  26. {ofsc-2.26.2 → ofsc-2.27.0}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
  27. {ofsc-2.26.2 → ofsc-2.27.0}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
  28. {ofsc-2.26.2 → ofsc-2.27.0}/.github/workflows/release.yml +0 -0
  29. {ofsc-2.26.2 → ofsc-2.27.0}/.github/workflows/test.yml +0 -0
  30. {ofsc-2.26.2 → ofsc-2.27.0}/.gitignore +0 -0
  31. {ofsc-2.26.2 → ofsc-2.27.0}/CODE_OF_CONDUCT.md +0 -0
  32. {ofsc-2.26.2 → ofsc-2.27.0}/LICENSE.txt +0 -0
  33. {ofsc-2.26.2 → ofsc-2.27.0}/SECURITY.md +0 -0
  34. {ofsc-2.26.2 → ofsc-2.27.0}/docs/swagger.json +0 -0
  35. {ofsc-2.26.2 → ofsc-2.27.0}/examples/Pipfile.examples +0 -0
  36. {ofsc-2.26.2 → ofsc-2.27.0}/examples/README.md +0 -0
  37. {ofsc-2.26.2 → ofsc-2.27.0}/examples/async_antipatterns.py +0 -0
  38. {ofsc-2.26.2 → ofsc-2.27.0}/examples/async_basic_usage.py +0 -0
  39. {ofsc-2.26.2 → ofsc-2.27.0}/examples/async_get_all_workzones.py +0 -0
  40. {ofsc-2.26.2 → ofsc-2.27.0}/examples/async_parallel_pagination.py +0 -0
  41. {ofsc-2.26.2 → ofsc-2.27.0}/examples/async_parallel_requests.py +0 -0
  42. {ofsc-2.26.2 → ofsc-2.27.0}/examples/config.py +0 -0
  43. {ofsc-2.26.2 → ofsc-2.27.0}/examples/export_routing_plans.py +0 -0
  44. {ofsc-2.26.2 → ofsc-2.27.0}/examples/get_capacity_areas.py +0 -0
  45. {ofsc-2.26.2 → ofsc-2.27.0}/examples/get_users_simple.py +0 -0
  46. {ofsc-2.26.2 → ofsc-2.27.0}/examples/get_work_skill_conditions.py +0 -0
  47. {ofsc-2.26.2 → ofsc-2.27.0}/examples/get_workzones.py +0 -0
  48. {ofsc-2.26.2 → ofsc-2.27.0}/examples/profile_parallel_pagination.py +0 -0
  49. {ofsc-2.26.2 → ofsc-2.27.0}/justfile +0 -0
  50. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/__init__.py +0 -0
  51. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/__init__.py +0 -0
  52. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/_http_config.py +0 -0
  53. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/_protocols.py +0 -0
  54. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/capacity.py +0 -0
  55. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/core/__init__.py +0 -0
  56. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/core/inventories.py +0 -0
  57. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/core/resources.py +0 -0
  58. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/core/users.py +0 -0
  59. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/metadata.py +0 -0
  60. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/oauth.py +0 -0
  61. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/async_client/statistics.py +0 -0
  62. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/capacity.py +0 -0
  63. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/common.py +0 -0
  64. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/exceptions.py +0 -0
  65. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/metadata.py +0 -0
  66. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/models/capacity.py +0 -0
  67. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/models/inventories.py +0 -0
  68. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/models/resources.py +0 -0
  69. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/models/statistics.py +0 -0
  70. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/models/users.py +0 -0
  71. {ofsc-2.26.2 → ofsc-2.27.0}/ofsc/oauth.py +0 -0
  72. {ofsc-2.26.2 → ofsc-2.27.0}/scripts/README.md +0 -0
  73. {ofsc-2.26.2 → ofsc-2.27.0}/scripts/capture_api_responses.py +0 -0
  74. {ofsc-2.26.2 → ofsc-2.27.0}/scripts/update_endpoints_doc.py +0 -0
  75. {ofsc-2.26.2 → ofsc-2.27.0}/tests/REQUIREMENTS_TEST_MAPPING.md +0 -0
  76. {ofsc-2.26.2 → ofsc-2.27.0}/tests/TEST_EXECUTION_SUMMARY.md +0 -0
  77. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/__init__.py +0 -0
  78. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/conftest.py +0 -0
  79. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_activities.py +0 -0
  80. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_activity_type_groups.py +0 -0
  81. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_activity_types.py +0 -0
  82. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_applications.py +0 -0
  83. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_capacity.py +0 -0
  84. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_capacity_areas.py +0 -0
  85. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_capacity_categories.py +0 -0
  86. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_daily_extract.py +0 -0
  87. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_exceptions.py +0 -0
  88. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_forms.py +0 -0
  89. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_http_config.py +0 -0
  90. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_inventories.py +0 -0
  91. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_inventory_types.py +0 -0
  92. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_languages.py +0 -0
  93. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_link_templates.py +0 -0
  94. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_map_layers.py +0 -0
  95. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_metadata_roundtrip.py +0 -0
  96. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_non_working_reasons.py +0 -0
  97. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_oauth.py +0 -0
  98. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_ofsc.py +0 -0
  99. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_organizations.py +0 -0
  100. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_plugins.py +0 -0
  101. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_populate_status.py +0 -0
  102. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_properties.py +0 -0
  103. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_resource_types.py +0 -0
  104. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_resources_get.py +0 -0
  105. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_resources_write.py +0 -0
  106. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_routing_profiles.py +0 -0
  107. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_shifts.py +0 -0
  108. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_statistics.py +0 -0
  109. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_subscriptions.py +0 -0
  110. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_time_slots.py +0 -0
  111. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_users.py +0 -0
  112. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_workskills.py +0 -0
  113. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_async_workzones.py +0 -0
  114. {ofsc-2.26.2 → ofsc-2.27.0}/tests/async/test_metadata_model_audit.py +0 -0
  115. {ofsc-2.26.2 → ofsc-2.27.0}/tests/capacity/README.md +0 -0
  116. {ofsc-2.26.2 → ofsc-2.27.0}/tests/capacity/__init__.py +0 -0
  117. {ofsc-2.26.2 → ofsc-2.27.0}/tests/capacity/real_responses.json +0 -0
  118. {ofsc-2.26.2 → ofsc-2.27.0}/tests/capacity/test_capacity_integration.py +0 -0
  119. {ofsc-2.26.2 → ofsc-2.27.0}/tests/capacity/test_capacity_mocked.py +0 -0
  120. {ofsc-2.26.2 → ofsc-2.27.0}/tests/capacity/test_quota_integration.py +0 -0
  121. {ofsc-2.26.2 → ofsc-2.27.0}/tests/capacity/test_quota_mocked.py +0 -0
  122. {ofsc-2.26.2 → ofsc-2.27.0}/tests/capacity/test_real_quota_validation.py +0 -0
  123. {ofsc-2.26.2 → ofsc-2.27.0}/tests/conftest.py +0 -0
  124. {ofsc-2.26.2 → ofsc-2.27.0}/tests/core/test_activities.py +0 -0
  125. {ofsc-2.26.2 → ofsc-2.27.0}/tests/core/test_daily.py +0 -0
  126. {ofsc-2.26.2 → ofsc-2.27.0}/tests/core/test_resources.py +0 -0
  127. {ofsc-2.26.2 → ofsc-2.27.0}/tests/core/test_subscriptions.py +0 -0
  128. {ofsc-2.26.2 → ofsc-2.27.0}/tests/core/test_users.py +0 -0
  129. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_activity_groups_types.py +0 -0
  130. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_applications.py +0 -0
  131. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_capacity_areas.py +0 -0
  132. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_capacity_categories.py +0 -0
  133. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_inventory_types.py +0 -0
  134. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_organizations.py +0 -0
  135. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_plugins.py +0 -0
  136. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_resource_types.py +0 -0
  137. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_routing_profiles.py +0 -0
  138. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_routing_profiles_write.py +0 -0
  139. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_workskilll_groups.py +0 -0
  140. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_workskills.py +0 -0
  141. {ofsc-2.26.2 → ofsc-2.27.0}/tests/metadata/test_workzones.py +0 -0
  142. {ofsc-2.26.2 → ofsc-2.27.0}/tests/test_base.py +0 -0
  143. {ofsc-2.26.2 → ofsc-2.27.0}/tests/test_get_activities_params.py +0 -0
  144. {ofsc-2.26.2 → ofsc-2.27.0}/tests/test_token.py +0 -0
@@ -0,0 +1,47 @@
1
+ name: Publish to PyPI (manual)
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ inputs:
6
+ ref:
7
+ description: "Git ref (branch, tag or SHA) to build and publish"
8
+ required: true
9
+ default: master
10
+ dry_run:
11
+ description: "Build and check the package without uploading it"
12
+ type: boolean
13
+ default: true
14
+
15
+ permissions:
16
+ contents: read
17
+ id-token: write
18
+
19
+ jobs:
20
+ publish:
21
+ runs-on: ubuntu-latest
22
+ environment:
23
+ name: pypi
24
+ steps:
25
+ - uses: actions/checkout@v4
26
+ with:
27
+ ref: ${{ inputs.ref }}
28
+
29
+ - name: Extract version
30
+ id: version
31
+ run: |
32
+ VERSION=$(grep '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
33
+ echo "version=$VERSION" >> $GITHUB_OUTPUT
34
+ echo "Publishing version: $VERSION from ${{ inputs.ref }}"
35
+
36
+ - name: Install uv
37
+ uses: astral-sh/setup-uv@v4
38
+
39
+ - name: Set up Python
40
+ run: uv python install 3.14
41
+
42
+ - name: Build package
43
+ run: uv build
44
+
45
+ - name: Publish to PyPI
46
+ if: ${{ !inputs.dry_run }}
47
+ run: uv publish
ofsc-2.27.0/AGENTS.md ADDED
@@ -0,0 +1,11 @@
1
+ # Instructions for coding agents
2
+
3
+ Before creating or submitting a pull request, read `CONTRIBUTING.md` and follow its contribution requirements.
4
+
5
+ In particular:
6
+
7
+ - Every commit must have a cryptographic signature (GPG, SSH, or S/MIME) that GitHub verifies as **Verified**. A `Signed-off-by` line is not a cryptographic signature and does not meet this requirement.
8
+ - Keep feature branch history linear; do not include merge commits. Rebase when needed to preserve a clean, reviewable history.
9
+ - After pushing, verify on GitHub that every commit displays the **Verified** badge.
10
+
11
+ See the commit-signing setup guide linked from `CONTRIBUTING.md`: https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits
@@ -2,9 +2,9 @@
2
2
 
3
3
  First off, thanks for taking the time to contribute! ❤️
4
4
 
5
- All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
5
+ All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to[...]
6
6
 
7
- > And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
7
+ > And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy ab[...]
8
8
  > - Star the project
9
9
  > - Tweet about it
10
10
  > - Refer this project in your project's readme
@@ -37,7 +37,7 @@ to <>.
37
37
 
38
38
  > If you want to ask a question, we assume that you have read the available [Documentation]().
39
39
 
40
- Before you ask a question, it is best to search for existing [Issues](/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
40
+ Before you ask a question, it is best to search for existing [Issues](/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in an issue.
41
41
 
42
42
  If you then still feel the need to ask a question and need clarification, we recommend the following:
43
43
 
@@ -52,18 +52,18 @@ We will then take care of the issue as soon as possible.
52
52
  ## I Want To Contribute
53
53
 
54
54
  > ### Legal Notice
55
- > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
55
+ > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project's license.
56
56
 
57
57
  ### Reporting Bugs
58
58
 
59
59
 
60
60
  #### Before Submitting a Bug Report
61
61
 
62
- A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
62
+ A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your bug report.
63
63
 
64
64
  - Make sure that you are using the latest version.
65
- - Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)).
66
- - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](issues?q=label%3Abug).
65
+ - Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you can also talk to the project maintainers).
66
+ - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](/issues).
67
67
  - Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
68
68
  - Collect information about the bug:
69
69
  - Stack trace (Traceback)
@@ -75,20 +75,20 @@ A good bug report shouldn't leave others needing to chase you up for more inform
75
75
 
76
76
  #### How Do I Submit a Good Bug Report?
77
77
 
78
- > You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.
78
+ > You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to the maintainers privately.
79
79
 
80
80
 
81
81
  We use GitHub issues to track bugs and errors. If you run into an issue with the project:
82
82
 
83
83
  - Open an [Issue](/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
84
84
  - Explain the behavior you would expect and the actual behavior.
85
- - Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
85
+ - Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports, follow the template in the issue form if present.
86
86
  - Provide the information you collected in the previous section.
87
87
 
88
88
  Once it's filed:
89
89
 
90
90
  - The project team will label the issue accordingly.
91
- - A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
91
+ - A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-more-info`.
92
92
  - If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
93
93
 
94
94
 
@@ -96,7 +96,7 @@ Once it's filed:
96
96
 
97
97
  ### Suggesting Enhancements
98
98
 
99
- This section guides you through submitting an enhancement suggestion for CONTRIBUTING.md, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
99
+ This section guides you through submitting an enhancement suggestion for CONTRIBUTING.md, **including completely new features and minor improvements to existing functionality**. Following these guides helps maintainers understand your suggestion and find the right way to address it.
100
100
 
101
101
 
102
102
  #### Before Submitting an Enhancement
@@ -104,7 +104,7 @@ This section guides you through submitting an enhancement suggestion for CONTRIB
104
104
  - Make sure that you are using the latest version.
105
105
  - Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
106
106
  - Perform a [search](/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
107
- - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
107
+ - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of users and not just a small subset.
108
108
 
109
109
 
110
110
  #### How Do I Submit a Good Enhancement Suggestion?
@@ -114,13 +114,22 @@ Enhancement suggestions are tracked as [GitHub issues](/issues).
114
114
  - Use a **clear and descriptive title** for the issue to identify the suggestion.
115
115
  - Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
116
116
  - **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
117
- - You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
117
+ - You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/).
118
118
  - **Explain why this enhancement would be useful** to most CONTRIBUTING.md users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
119
119
 
120
120
 
121
121
 
122
122
  ### Your First Code Contribution
123
123
 
124
+ Before opening a pull request, contributors should ensure:
125
+
126
+ - every commit has a cryptographic signature (GPG, SSH, or S/MIME) that GitHub verifies as **Verified**
127
+ - the branch history remains linear (no merge commits in feature branches)
128
+ - the branch is rebased when needed to preserve a clean, reviewable history
129
+
130
+ Configure commit signing by following GitHub's [guide to signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
131
+ A `Signed-off-by` line is a DCO attestation, not a cryptographic signature, and does not satisfy this requirement.
132
+ After pushing, check the commits on GitHub and confirm each displays the **Verified** badge.
124
133
 
125
134
  ### Improving The Documentation
126
135
 
@@ -128,6 +137,8 @@ Enhancement suggestions are tracked as [GitHub issues](/issues).
128
137
  ## Styleguides
129
138
  ### Commit Messages
130
139
 
140
+ All commits must have a cryptographic signature verified by GitHub; a `Signed-off-by` line alone does not count. See [commit-signing setup](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). Commits should preserve a linear project history. Rebase or squash before opening a pull request if your branch contains merge commits or otherwise introduces non-linear history.
141
+
131
142
 
132
143
  ## Join The Project Team
133
144
 
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.4
1
+ Metadata-Version: 2.5
2
2
  Name: ofsc
3
- Version: 2.26.2
3
+ Version: 2.27.0
4
4
  Summary: Python wrapper for Oracle Field Service API
5
5
  Project-URL: Repository, https://github.com/btoron/pyOFSC
6
6
  Author-email: Borja Toron <borja.toron@gmail.com>
@@ -41,6 +41,25 @@ async with AsyncOFSC(clientID="...", secret="...", companyName="...") as client:
41
41
  - **Request/Response Logging**: Optional httpx event hooks for automatic API call tracing
42
42
  - **Async Generators**: Lazy pagination helpers that yield individual items across all pages (e.g. `get_all_workzones`, `get_all_resources`) `[Async]`
43
43
 
44
+ ### Streaming Daily Extract Downloads
45
+
46
+ Download large extracts incrementally with `core.get_daily_extract_file_stream`:
47
+
48
+ ```python
49
+ async with AsyncOFSC(clientID="...", secret="...", companyName="...") as client:
50
+ async with client.core.get_daily_extract_file_stream(
51
+ date="2024-01-15", filename="extract.zip", chunk_size=8192
52
+ ) as stream:
53
+ with open("extract.zip", "wb") as output:
54
+ async for chunk in stream:
55
+ output.write(chunk)
56
+ ```
57
+
58
+ The async context keeps the response open while chunks are consumed and closes it
59
+ on completion, early exit, errors, or cancellation. `chunk_size` must be positive.
60
+ Successful downloads are not buffered in full; HTTP error bodies are read to
61
+ preserve the same typed API exceptions as the buffered download method.
62
+
44
63
  ### Enabling Request/Response Logging
45
64
 
46
65
  Pass `enable_logging=True` to automatically log all HTTP requests and responses via Python's standard logging:
@@ -130,10 +149,31 @@ uv run pytest tests/async/test_async_workzones.py
130
149
 
131
150
  ## Implemented Functions
132
151
 
133
- **195 async endpoints** (80% coverage) and **89 sync endpoints** (37% coverage) across Core, Metadata, Capacity, Statistics, and Auth modules.
152
+ **197 async endpoints** (81% coverage) and **89 sync endpoints** (37% coverage) across Core, Metadata, Capacity, Statistics, and Auth modules.
134
153
 
135
154
  See [docs/ENDPOINTS.md](docs/ENDPOINTS.md) for the full implementation status table.
136
155
 
156
+ ### Async core operations
157
+
158
+ - `core.search_activities(params)` returns an `ActivityListResponse` and accepts
159
+ the [search API's query parameters](https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-custom-actions-search-get.html),
160
+ including `searchInField`, `searchForValue`, date filters, offset and limit.
161
+ - `core.move_activity(activity_id, data)` sends the action object and returns
162
+ `None` for a successful [204 move response](https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-activityid-custom-actions-move-post.html).
163
+ - `core.bulk_update(BulkUpdateRequest(...))` returns a `BulkUpdateResponse`.
164
+ Explicit nulls are preserved, including `activityId=None` for creation; unset
165
+ optional fields are omitted. Inspect each result's errors, operations and
166
+ warnings: [bulk updates](https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-custom-actions-bulkupdate-post.html)
167
+ can partially fail within a successful HTTP response.
168
+
169
+ `core.get_all_activities(...)` and `core.get_all_properties(...)` collect all
170
+ pages into typed `OFSResponseList` containers. Activity dates default to seven
171
+ days before/after the current day; provide both bounds for another range.
172
+ `activity_fields` and `additional_fields` control which fields are fetched.
173
+ Offsets advance by the number of returned items, and an empty page claiming
174
+ more data raises `OFSCApiError`. Both helpers hold the complete result in memory;
175
+ use `core.get_activities` or `metadata.get_properties` for individual pages.
176
+
137
177
  ## Usage Examples
138
178
 
139
179
  **Sync:**
@@ -152,6 +192,29 @@ async with AsyncOFSC(clientID="...", secret="...", companyName="...") as client:
152
192
 
153
193
  See the [examples/](examples/) directory for comprehensive sync and async usage examples.
154
194
 
195
+ ### Streaming Daily Extract Downloads
196
+
197
+ The synchronous client can download large extracts without buffering the full
198
+ successful response in memory. Use the response as a context manager and choose
199
+ the chunk size through Requests' `iter_content` method:
200
+
201
+ ```python
202
+ with instance.core.get_daily_extract_file_stream(
203
+ date="2026-01-15", filename="extract.zip", timeout=(5, 60)
204
+ ) as stream:
205
+ with open("extract.zip", "wb") as destination:
206
+ for chunk in stream.iter_content(chunk_size=8192):
207
+ if chunk:
208
+ destination.write(chunk)
209
+ ```
210
+
211
+ The response closes on context exit, including after an early break or an
212
+ exception. The optional timeout specifies connect and read timeouts; omitting
213
+ it preserves Requests' default. With the default `auto_raise=True`, OFSC JSON
214
+ errors raise `OFSAPIException`, and other unsuccessful responses raise
215
+ `requests.HTTPError`. If `auto_raise=False`, check `stream.status_code` before
216
+ writing the body. `get_daily_extract_file` continues to return buffered bytes.
217
+
155
218
  ## Test History
156
219
 
157
220
  OFS REST API Version | PyOFSC
@@ -25,6 +25,25 @@ async with AsyncOFSC(clientID="...", secret="...", companyName="...") as client:
25
25
  - **Request/Response Logging**: Optional httpx event hooks for automatic API call tracing
26
26
  - **Async Generators**: Lazy pagination helpers that yield individual items across all pages (e.g. `get_all_workzones`, `get_all_resources`) `[Async]`
27
27
 
28
+ ### Streaming Daily Extract Downloads
29
+
30
+ Download large extracts incrementally with `core.get_daily_extract_file_stream`:
31
+
32
+ ```python
33
+ async with AsyncOFSC(clientID="...", secret="...", companyName="...") as client:
34
+ async with client.core.get_daily_extract_file_stream(
35
+ date="2024-01-15", filename="extract.zip", chunk_size=8192
36
+ ) as stream:
37
+ with open("extract.zip", "wb") as output:
38
+ async for chunk in stream:
39
+ output.write(chunk)
40
+ ```
41
+
42
+ The async context keeps the response open while chunks are consumed and closes it
43
+ on completion, early exit, errors, or cancellation. `chunk_size` must be positive.
44
+ Successful downloads are not buffered in full; HTTP error bodies are read to
45
+ preserve the same typed API exceptions as the buffered download method.
46
+
28
47
  ### Enabling Request/Response Logging
29
48
 
30
49
  Pass `enable_logging=True` to automatically log all HTTP requests and responses via Python's standard logging:
@@ -114,10 +133,31 @@ uv run pytest tests/async/test_async_workzones.py
114
133
 
115
134
  ## Implemented Functions
116
135
 
117
- **195 async endpoints** (80% coverage) and **89 sync endpoints** (37% coverage) across Core, Metadata, Capacity, Statistics, and Auth modules.
136
+ **197 async endpoints** (81% coverage) and **89 sync endpoints** (37% coverage) across Core, Metadata, Capacity, Statistics, and Auth modules.
118
137
 
119
138
  See [docs/ENDPOINTS.md](docs/ENDPOINTS.md) for the full implementation status table.
120
139
 
140
+ ### Async core operations
141
+
142
+ - `core.search_activities(params)` returns an `ActivityListResponse` and accepts
143
+ the [search API's query parameters](https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-custom-actions-search-get.html),
144
+ including `searchInField`, `searchForValue`, date filters, offset and limit.
145
+ - `core.move_activity(activity_id, data)` sends the action object and returns
146
+ `None` for a successful [204 move response](https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-activityid-custom-actions-move-post.html).
147
+ - `core.bulk_update(BulkUpdateRequest(...))` returns a `BulkUpdateResponse`.
148
+ Explicit nulls are preserved, including `activityId=None` for creation; unset
149
+ optional fields are omitted. Inspect each result's errors, operations and
150
+ warnings: [bulk updates](https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-custom-actions-bulkupdate-post.html)
151
+ can partially fail within a successful HTTP response.
152
+
153
+ `core.get_all_activities(...)` and `core.get_all_properties(...)` collect all
154
+ pages into typed `OFSResponseList` containers. Activity dates default to seven
155
+ days before/after the current day; provide both bounds for another range.
156
+ `activity_fields` and `additional_fields` control which fields are fetched.
157
+ Offsets advance by the number of returned items, and an empty page claiming
158
+ more data raises `OFSCApiError`. Both helpers hold the complete result in memory;
159
+ use `core.get_activities` or `metadata.get_properties` for individual pages.
160
+
121
161
  ## Usage Examples
122
162
 
123
163
  **Sync:**
@@ -136,6 +176,29 @@ async with AsyncOFSC(clientID="...", secret="...", companyName="...") as client:
136
176
 
137
177
  See the [examples/](examples/) directory for comprehensive sync and async usage examples.
138
178
 
179
+ ### Streaming Daily Extract Downloads
180
+
181
+ The synchronous client can download large extracts without buffering the full
182
+ successful response in memory. Use the response as a context manager and choose
183
+ the chunk size through Requests' `iter_content` method:
184
+
185
+ ```python
186
+ with instance.core.get_daily_extract_file_stream(
187
+ date="2026-01-15", filename="extract.zip", timeout=(5, 60)
188
+ ) as stream:
189
+ with open("extract.zip", "wb") as destination:
190
+ for chunk in stream.iter_content(chunk_size=8192):
191
+ if chunk:
192
+ destination.write(chunk)
193
+ ```
194
+
195
+ The response closes on context exit, including after an early break or an
196
+ exception. The optional timeout specifies connect and read timeouts; omitting
197
+ it preserves Requests' default. With the default `auto_raise=True`, OFSC JSON
198
+ errors raise `OFSAPIException`, and other unsuccessful responses raise
199
+ `requests.HTTPError`. If `auto_raise=False`, check `stream.status_code` before
200
+ writing the body. `get_daily_extract_file` continues to return buffered bytes.
201
+
139
202
  ## Test History
140
203
 
141
204
  OFS REST API Version | PyOFSC
@@ -1,7 +1,7 @@
1
1
  # OFSC API Endpoints Reference
2
2
 
3
- **Version:** 2.26.0
4
- **Last Updated:** 2026-03-05
3
+ **Version:** 2.26.2
4
+ **Last Updated:** 2026-10-13
5
5
 
6
6
  This document provides a comprehensive reference of all Oracle Field Service Cloud (OFSC) API endpoints and their implementation status in pyOFSC.
7
7
 
@@ -147,8 +147,8 @@ This document provides a comprehensive reference of all Oracle Field Service Clo
147
147
  |CO013D|`/rest/ofscCore/v1/activities/{activityId}/linkedActivities/{linkedActivityId}/linkTypes/{linkType}` |core |DELETE|async |
148
148
  |CO013G|`/rest/ofscCore/v1/activities/{activityId}/linkedActivities/{linkedActivityId}/linkTypes/{linkType}` |core |GET |async |
149
149
  |CO013U|`/rest/ofscCore/v1/activities/{activityId}/linkedActivities/{linkedActivityId}/linkTypes/{linkType}` |core |PUT |async |
150
- |CO014G|`/rest/ofscCore/v1/activities/custom-actions/search` |core |GET |sync |
151
- |CO015P|`/rest/ofscCore/v1/activities/custom-actions/bulkUpdate` |core |POST |sync |
150
+ |CO014G|`/rest/ofscCore/v1/activities/custom-actions/search` |core |GET |both |
151
+ |CO015P|`/rest/ofscCore/v1/activities/custom-actions/bulkUpdate` |core |POST |both |
152
152
  |CO016P|`/rest/ofscCore/v1/activities/{activityId}/custom-actions/startPrework` |core |POST |- |
153
153
  |CO017P|`/rest/ofscCore/v1/activities/{activityId}/custom-actions/reopen` |core |POST |- |
154
154
  |CO018P|`/rest/ofscCore/v1/activities/{activityId}/custom-actions/delay` |core |POST |- |
@@ -157,7 +157,7 @@ This document provides a comprehensive reference of all Oracle Field Service Clo
157
157
  |CO021P|`/rest/ofscCore/v1/activities/{activityId}/custom-actions/enroute` |core |POST |- |
158
158
  |CO022P|`/rest/ofscCore/v1/activities/{activityId}/custom-actions/stopTravel` |core |POST |- |
159
159
  |CO023P|`/rest/ofscCore/v1/activities/{activityId}/custom-actions/suspend` |core |POST |- |
160
- |CO024P|`/rest/ofscCore/v1/activities/{activityId}/custom-actions/move` |core |POST |sync |
160
+ |CO024P|`/rest/ofscCore/v1/activities/{activityId}/custom-actions/move` |core |POST |both |
161
161
  |CO025P|`/rest/ofscCore/v1/activities/{activityId}/custom-actions/complete` |core |POST |- |
162
162
  |CO026P|`/rest/ofscCore/v1/activities/{activityId}/custom-actions/notDone` |core |POST |- |
163
163
  |CO027G|`/rest/ofscCore/v1/whereIsMyTech` |core |GET |- |
@@ -266,12 +266,12 @@ This document provides a comprehensive reference of all Oracle Field Service Clo
266
266
 
267
267
  ## Implementation Summary
268
268
 
269
- - **Sync only**: 4 endpoints
269
+ - **Sync only**: 1 endpoints
270
270
  - **Async only**: 109 endpoints
271
- - **Both**: 85 endpoints
271
+ - **Both**: 88 endpoints
272
272
  - **Not implemented**: 45 endpoints
273
273
  - **Total sync**: 89 endpoints
274
- - **Total async**: 194 endpoints
274
+ - **Total async**: 197 endpoints
275
275
 
276
276
  ## Implementation Statistics by Module and Method
277
277
 
@@ -293,13 +293,13 @@ This document provides a comprehensive reference of all Oracle Field Service Clo
293
293
  | Module | GET |Write (POST/PUT/PATCH)| DELETE | Total |
294
294
  |-------------|-------------------|----------------------|-----------------|-------------------|
295
295
  |metadata |51/51 (100.0%) |28/30 (93.3%) |5/5 (100.0%) |84/86 (97.7%) |
296
- |core |44/51 (86.3%) |31/56 (55.4%) |18/20 (90.0%) |93/127 (73.2%) |
296
+ |core |45/51 (88.2%) |33/56 (58.9%) |18/20 (90.0%) |96/127 (75.6%) |
297
297
  |capacity |6/7 (85.7%) |4/5 (80.0%) |0/0 (0%) |10/12 (83.3%) |
298
298
  |statistics |3/3 (100.0%) |3/3 (100.0%) |0/0 (0%) |6/6 (100.0%) |
299
299
  |partscatalog |0/0 (0%) |0/2 (0.0%) |0/1 (0.0%) |0/3 (0.0%) |
300
300
  |collaboration|0/3 (0.0%) |0/4 (0.0%) |0/0 (0%) |0/7 (0.0%) |
301
301
  |auth |0/0 (0%) |1/2 (50.0%) |0/0 (0%) |1/2 (50.0%) |
302
- |**Total** |**104/115 (90.4%)**|**67/102 (65.7%)** |**23/26 (88.5%)**|**194/243 (79.8%)**|
302
+ |**Total** |**105/115 (91.3%)**|**69/102 (67.6%)** |**23/26 (88.5%)**|**197/243 (81.1%)**|
303
303
 
304
304
  ## Endpoint ID Reference
305
305
 
@@ -335,7 +335,7 @@ class AsyncClientBase:
335
335
  response = await self._client.put(
336
336
  url,
337
337
  headers=self.headers,
338
- json=data.model_dump(exclude_none=True, mode="json"),
338
+ json=data.model_dump(exclude_none=True, mode="json", by_alias=True),
339
339
  )
340
340
  response.raise_for_status()
341
341
  result = self._clean_response(response.json())
@@ -378,7 +378,7 @@ class AsyncClientBase:
378
378
  response = await self._client.post(
379
379
  url,
380
380
  headers=self.headers,
381
- content=data.model_dump_json(exclude_none=True),
381
+ content=data.model_dump_json(exclude_none=True, by_alias=True),
382
382
  )
383
383
  response.raise_for_status()
384
384
  result = self._clean_response(response.json())
@@ -421,7 +421,7 @@ class AsyncClientBase:
421
421
  response = await self._client.patch(
422
422
  url,
423
423
  headers=self.headers,
424
- content=data.model_dump_json(exclude_none=True).encode("utf-8"),
424
+ content=data.model_dump_json(exclude_none=True, by_alias=True).encode("utf-8"),
425
425
  )
426
426
  response.raise_for_status()
427
427
  result = self._clean_response(response.json())