current-cli 0.1.9__tar.gz → 0.1.11__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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: current-cli
3
- Version: 0.1.9
3
+ Version: 0.1.11
4
4
  Summary: Command line interface for the Current API, generated from its OpenAPI schema at runtime
5
5
  Author-email: Orin <your-email@example.com>
6
6
  License-Expression: MIT
@@ -91,7 +91,28 @@ paths:
91
91
  /api/contacts/contacts/:
92
92
  get:
93
93
  operationId: contacts_contacts_list
94
+ description: |-
95
+ Offset/limit page, ordered by name (the model's own
96
+ ``Meta.ordering``) so offsets stay stable across pages — a real
97
+ workspace directory can hold far more contacts than fit in one
98
+ response.
94
99
  parameters:
100
+ - in: query
101
+ name: limit
102
+ schema:
103
+ type: integer
104
+ description: Max contacts per page (default 25, cap 100)
105
+ - in: query
106
+ name: offset
107
+ schema:
108
+ type: integer
109
+ description: Page offset (default 0)
110
+ - in: query
111
+ name: search
112
+ schema:
113
+ type: string
114
+ description: Case-insensitive match against name, company, role, or any address
115
+ value
95
116
  - in: query
96
117
  name: workspace
97
118
  schema:
@@ -106,9 +127,7 @@ paths:
106
127
  content:
107
128
  application/json:
108
129
  schema:
109
- type: array
110
- items:
111
- $ref: '#/components/schemas/Contact'
130
+ $ref: '#/components/schemas/ContactListResponse'
112
131
  description: ''
113
132
  post:
114
133
  operationId: contacts_contacts_create
@@ -273,6 +292,36 @@ paths:
273
292
  schema:
274
293
  $ref: '#/components/schemas/ContactAddress'
275
294
  description: ''
295
+ /api/contacts/contacts/{id}/addresses/{address_id}/:
296
+ delete:
297
+ operationId: contacts_contacts_addresses_destroy
298
+ description: |-
299
+ Remove an address. Editing a member contact is admin-only (same
300
+ as ``add_address``); removing a *verified* address is admin-only
301
+ regardless of contact, since verification is what makes an address
302
+ approval-capable — a member must not be able to unilaterally strip
303
+ that off their own directory entry.
304
+ parameters:
305
+ - in: path
306
+ name: address_id
307
+ schema:
308
+ type: string
309
+ pattern: ^[^/]+$
310
+ required: true
311
+ - in: path
312
+ name: id
313
+ schema:
314
+ type: string
315
+ format: uuid
316
+ description: A UUID string identifying this contact.
317
+ required: true
318
+ tags:
319
+ - contacts
320
+ security:
321
+ - tokenAuth: []
322
+ responses:
323
+ '204':
324
+ description: No response body
276
325
  /api/contacts/contacts/{id}/addresses/{address_id}/verify/:
277
326
  post:
278
327
  operationId: contacts_contacts_addresses_verify_create
@@ -1525,6 +1574,11 @@ paths:
1525
1574
  transitions inline. POST creates a run of a WorkflowDefinition and
1526
1575
  dispatches it (or queues it behind the per-project write queue).
1527
1576
  parameters:
1577
+ - in: query
1578
+ name: archived
1579
+ schema:
1580
+ type: boolean
1581
+ description: Filter by archived state. Defaults to false (hides archived runs).
1528
1582
  - in: query
1529
1583
  name: definition
1530
1584
  schema:
@@ -1613,6 +1667,52 @@ paths:
1613
1667
  schema:
1614
1668
  $ref: '#/components/schemas/WorkflowRun'
1615
1669
  description: ''
1670
+ /api/workflows/runs/{id}/archive/:
1671
+ post:
1672
+ operationId: workflows_runs_archive_create
1673
+ description: Hide the run from the default Actions list.
1674
+ parameters:
1675
+ - in: path
1676
+ name: id
1677
+ schema:
1678
+ type: string
1679
+ format: uuid
1680
+ description: A UUID string identifying this workflow run.
1681
+ required: true
1682
+ tags:
1683
+ - workflows
1684
+ security:
1685
+ - tokenAuth: []
1686
+ responses:
1687
+ '200':
1688
+ content:
1689
+ application/json:
1690
+ schema:
1691
+ $ref: '#/components/schemas/WorkflowRun'
1692
+ description: ''
1693
+ /api/workflows/runs/{id}/unarchive/:
1694
+ post:
1695
+ operationId: workflows_runs_unarchive_create
1696
+ description: Restore an archived run to the default Actions list.
1697
+ parameters:
1698
+ - in: path
1699
+ name: id
1700
+ schema:
1701
+ type: string
1702
+ format: uuid
1703
+ description: A UUID string identifying this workflow run.
1704
+ required: true
1705
+ tags:
1706
+ - workflows
1707
+ security:
1708
+ - tokenAuth: []
1709
+ responses:
1710
+ '200':
1711
+ content:
1712
+ application/json:
1713
+ schema:
1714
+ $ref: '#/components/schemas/WorkflowRun'
1715
+ description: ''
1616
1716
  /api/workflows/runs/{run_id}/definition/:
1617
1717
  get:
1618
1718
  operationId: workflows_runs_definition_retrieve
@@ -2544,6 +2644,28 @@ components:
2544
2644
  required:
2545
2645
  - kind
2546
2646
  - value
2647
+ ContactListResponse:
2648
+ type: object
2649
+ description: |-
2650
+ Offset/limit envelope for the contacts list: ordered by name (the
2651
+ model's own ``Meta.ordering``), so offsets stay stable across pages.
2652
+
2653
+ ``many=False`` above stops drf-spectacular's list-view heuristic from
2654
+ wrapping this envelope in an extra array, since it's a single object.
2655
+ properties:
2656
+ items:
2657
+ type: array
2658
+ items:
2659
+ $ref: '#/components/schemas/Contact'
2660
+ total:
2661
+ type: integer
2662
+ next_offset:
2663
+ type: integer
2664
+ nullable: true
2665
+ required:
2666
+ - items
2667
+ - next_offset
2668
+ - total
2547
2669
  ContactRequest:
2548
2670
  type: object
2549
2671
  properties:
@@ -3926,12 +4048,22 @@ components:
3926
4048
  error:
3927
4049
  type: string
3928
4050
  readOnly: true
4051
+ archived:
4052
+ type: boolean
4053
+ readOnly: true
4054
+ archived_at:
4055
+ type: string
4056
+ format: date-time
4057
+ readOnly: true
4058
+ nullable: true
3929
4059
  transitions:
3930
4060
  type: array
3931
4061
  items:
3932
4062
  $ref: '#/components/schemas/StepTransition'
3933
4063
  readOnly: true
3934
4064
  required:
4065
+ - archived
4066
+ - archived_at
3935
4067
  - definition
3936
4068
  - dispatched_at
3937
4069
  - error
@@ -84,6 +84,16 @@ POST /api/contacts/contacts/{id}/add_address/
84
84
  Options:
85
85
  - `--data` (required) - Request body as JSON: inline, @file.json, or - for stdin.
86
86
 
87
+ ### current contacts addresses destroy <id> <address_id>
88
+
89
+ Remove an address. Editing a member contact is admin-only (same
90
+ as ``add_address``); removing a *verified* address is admin-only
91
+ regardless of contact, since verification is what makes an address
92
+ approval-capable — a member must not be able to unilaterally strip
93
+ that off their own directory entry.
94
+
95
+ DELETE /api/contacts/contacts/{id}/addresses/{address_id}/
96
+
87
97
  ### current contacts addresses verify create <id> <address_id>
88
98
 
89
99
  Admin-only: mark an address as platform-verified. Verification is
@@ -104,9 +114,17 @@ DELETE /api/contacts/contacts/{id}/
104
114
 
105
115
  ### current contacts list
106
116
 
117
+ Offset/limit page, ordered by name (the model's own
118
+ ``Meta.ordering``) so offsets stay stable across pages — a real
119
+ workspace directory can hold far more contacts than fit in one
120
+ response.
121
+
107
122
  GET /api/contacts/contacts/
108
123
 
109
124
  Options:
125
+ - `--limit` - Max contacts per page (default 25, cap 100)
126
+ - `--offset` - Page offset (default 0)
127
+ - `--search` - Case-insensitive match against name, company, role, or any address value
110
128
  - `--workspace` - Filter by workspace UUID
111
129
 
112
130
  ### current contacts partial-update <id>
@@ -558,6 +576,12 @@ Workflows across the caller's workspaces. Any member can create and edit.
558
576
 
559
577
  GET /api/workflows/workflows/{id}/
560
578
 
579
+ ### current workflows runs archive create <id>
580
+
581
+ Hide the run from the default Actions list.
582
+
583
+ POST /api/workflows/runs/{id}/archive/
584
+
561
585
  ### current workflows runs create
562
586
 
563
587
  Run history for workflows in the caller's workspaces, with step
@@ -586,6 +610,7 @@ dispatches it (or queues it behind the per-project write queue).
586
610
  GET /api/workflows/runs/
587
611
 
588
612
  Options:
613
+ - `--archived` - Filter by archived state. Defaults to false (hides archived runs).
589
614
  - `--definition` - Filter by definition UUID
590
615
  - `--project` - Filter by project UUID
591
616
  - `--workflow` - Filter by workflow UUID
@@ -627,6 +652,12 @@ POST /api/workflows/runs/{run_id}/transitions/
627
652
  Options:
628
653
  - `--data` (required) - Request body as JSON: inline, @file.json, or - for stdin.
629
654
 
655
+ ### current workflows runs unarchive create <id>
656
+
657
+ Restore an archived run to the default Actions list.
658
+
659
+ POST /api/workflows/runs/{id}/unarchive/
660
+
630
661
  ### current workflows update <id>
631
662
 
632
663
  Workflows across the caller's workspaces. Any member can create and edit.
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "current-cli"
3
- version = "0.1.9"
3
+ version = "0.1.11"
4
4
  description = "Command line interface for the Current API, generated from its OpenAPI schema at runtime"
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.10"
File without changes
File without changes