Skip to content

Commit b885bfa

Browse files
stainless-botstainless-bot
committed
docs(api): update metadata docstrings (#69)
1 parent 7e1f5b6 commit b885bfa

28 files changed

+342
-126
lines changed

‎src/orb/resources/customers/credits/ledger.py

+60-20
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,9 @@ def create_entry(
346346
per_unit_cost_basis, as the calculation of the invoice total is done on that
347347
basis.
348348
349-
metadata: User-specified key/value pairs for the resource.
349+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
350+
by setting the value to `null`, and the entire metadata mapping can be cleared
351+
by setting `metadata` to `null`.
350352
351353
per_unit_cost_basis: Can only be specified when entry_type=increment. How much, in USD, a customer
352354
paid for a single credit in this block
@@ -499,7 +501,9 @@ def create_entry(
499501
For example, this can be used to note an increment refers to trial credits, or
500502
for noting corrections as a result of an incident, etc.
501503
502-
metadata: User-specified key/value pairs for the resource.
504+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
505+
by setting the value to `null`, and the entire metadata mapping can be cleared
506+
by setting `metadata` to `null`.
503507
504508
extra_headers: Send extra headers
505509
@@ -662,7 +666,9 @@ def create_entry(
662666
For example, this can be used to note an increment refers to trial credits, or
663667
for noting corrections as a result of an incident, etc.
664668
665-
metadata: User-specified key/value pairs for the resource.
669+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
670+
by setting the value to `null`, and the entire metadata mapping can be cleared
671+
by setting `metadata` to `null`.
666672
667673
extra_headers: Send extra headers
668674
@@ -816,7 +822,9 @@ def create_entry(
816822
For example, this can be used to note an increment refers to trial credits, or
817823
for noting corrections as a result of an incident, etc.
818824
819-
metadata: User-specified key/value pairs for the resource.
825+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
826+
by setting the value to `null`, and the entire metadata mapping can be cleared
827+
by setting `metadata` to `null`.
820828
821829
void_reason: Can only be specified when `entry_type=void`. The reason for the void.
822830
@@ -971,7 +979,9 @@ def create_entry(
971979
For example, this can be used to note an increment refers to trial credits, or
972980
for noting corrections as a result of an incident, etc.
973981
974-
metadata: User-specified key/value pairs for the resource.
982+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
983+
by setting the value to `null`, and the entire metadata mapping can be cleared
984+
by setting `metadata` to `null`.
975985
976986
extra_headers: Send extra headers
977987
@@ -1207,7 +1217,9 @@ def create_entry_by_external_id(
12071217
per_unit_cost_basis, as the calculation of the invoice total is done on that
12081218
basis.
12091219
1210-
metadata: User-specified key/value pairs for the resource.
1220+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
1221+
by setting the value to `null`, and the entire metadata mapping can be cleared
1222+
by setting `metadata` to `null`.
12111223
12121224
per_unit_cost_basis: Can only be specified when entry_type=increment. How much, in USD, a customer
12131225
paid for a single credit in this block
@@ -1360,7 +1372,9 @@ def create_entry_by_external_id(
13601372
For example, this can be used to note an increment refers to trial credits, or
13611373
for noting corrections as a result of an incident, etc.
13621374
1363-
metadata: User-specified key/value pairs for the resource.
1375+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
1376+
by setting the value to `null`, and the entire metadata mapping can be cleared
1377+
by setting `metadata` to `null`.
13641378
13651379
extra_headers: Send extra headers
13661380
@@ -1523,7 +1537,9 @@ def create_entry_by_external_id(
15231537
For example, this can be used to note an increment refers to trial credits, or
15241538
for noting corrections as a result of an incident, etc.
15251539
1526-
metadata: User-specified key/value pairs for the resource.
1540+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
1541+
by setting the value to `null`, and the entire metadata mapping can be cleared
1542+
by setting `metadata` to `null`.
15271543
15281544
extra_headers: Send extra headers
15291545
@@ -1677,7 +1693,9 @@ def create_entry_by_external_id(
16771693
For example, this can be used to note an increment refers to trial credits, or
16781694
for noting corrections as a result of an incident, etc.
16791695
1680-
metadata: User-specified key/value pairs for the resource.
1696+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
1697+
by setting the value to `null`, and the entire metadata mapping can be cleared
1698+
by setting `metadata` to `null`.
16811699
16821700
void_reason: Can only be specified when `entry_type=void`. The reason for the void.
16831701
@@ -1832,7 +1850,9 @@ def create_entry_by_external_id(
18321850
For example, this can be used to note an increment refers to trial credits, or
18331851
for noting corrections as a result of an incident, etc.
18341852
1835-
metadata: User-specified key/value pairs for the resource.
1853+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
1854+
by setting the value to `null`, and the entire metadata mapping can be cleared
1855+
by setting `metadata` to `null`.
18361856
18371857
extra_headers: Send extra headers
18381858
@@ -2390,7 +2410,9 @@ async def create_entry(
23902410
per_unit_cost_basis, as the calculation of the invoice total is done on that
23912411
basis.
23922412
2393-
metadata: User-specified key/value pairs for the resource.
2413+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
2414+
by setting the value to `null`, and the entire metadata mapping can be cleared
2415+
by setting `metadata` to `null`.
23942416
23952417
per_unit_cost_basis: Can only be specified when entry_type=increment. How much, in USD, a customer
23962418
paid for a single credit in this block
@@ -2543,7 +2565,9 @@ async def create_entry(
25432565
For example, this can be used to note an increment refers to trial credits, or
25442566
for noting corrections as a result of an incident, etc.
25452567
2546-
metadata: User-specified key/value pairs for the resource.
2568+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
2569+
by setting the value to `null`, and the entire metadata mapping can be cleared
2570+
by setting `metadata` to `null`.
25472571
25482572
extra_headers: Send extra headers
25492573
@@ -2706,7 +2730,9 @@ async def create_entry(
27062730
For example, this can be used to note an increment refers to trial credits, or
27072731
for noting corrections as a result of an incident, etc.
27082732
2709-
metadata: User-specified key/value pairs for the resource.
2733+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
2734+
by setting the value to `null`, and the entire metadata mapping can be cleared
2735+
by setting `metadata` to `null`.
27102736
27112737
extra_headers: Send extra headers
27122738
@@ -2860,7 +2886,9 @@ async def create_entry(
28602886
For example, this can be used to note an increment refers to trial credits, or
28612887
for noting corrections as a result of an incident, etc.
28622888
2863-
metadata: User-specified key/value pairs for the resource.
2889+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
2890+
by setting the value to `null`, and the entire metadata mapping can be cleared
2891+
by setting `metadata` to `null`.
28642892
28652893
void_reason: Can only be specified when `entry_type=void`. The reason for the void.
28662894
@@ -3015,7 +3043,9 @@ async def create_entry(
30153043
For example, this can be used to note an increment refers to trial credits, or
30163044
for noting corrections as a result of an incident, etc.
30173045
3018-
metadata: User-specified key/value pairs for the resource.
3046+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
3047+
by setting the value to `null`, and the entire metadata mapping can be cleared
3048+
by setting `metadata` to `null`.
30193049
30203050
extra_headers: Send extra headers
30213051
@@ -3251,7 +3281,9 @@ async def create_entry_by_external_id(
32513281
per_unit_cost_basis, as the calculation of the invoice total is done on that
32523282
basis.
32533283
3254-
metadata: User-specified key/value pairs for the resource.
3284+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
3285+
by setting the value to `null`, and the entire metadata mapping can be cleared
3286+
by setting `metadata` to `null`.
32553287
32563288
per_unit_cost_basis: Can only be specified when entry_type=increment. How much, in USD, a customer
32573289
paid for a single credit in this block
@@ -3404,7 +3436,9 @@ async def create_entry_by_external_id(
34043436
For example, this can be used to note an increment refers to trial credits, or
34053437
for noting corrections as a result of an incident, etc.
34063438
3407-
metadata: User-specified key/value pairs for the resource.
3439+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
3440+
by setting the value to `null`, and the entire metadata mapping can be cleared
3441+
by setting `metadata` to `null`.
34083442
34093443
extra_headers: Send extra headers
34103444
@@ -3567,7 +3601,9 @@ async def create_entry_by_external_id(
35673601
For example, this can be used to note an increment refers to trial credits, or
35683602
for noting corrections as a result of an incident, etc.
35693603
3570-
metadata: User-specified key/value pairs for the resource.
3604+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
3605+
by setting the value to `null`, and the entire metadata mapping can be cleared
3606+
by setting `metadata` to `null`.
35713607
35723608
extra_headers: Send extra headers
35733609
@@ -3721,7 +3757,9 @@ async def create_entry_by_external_id(
37213757
For example, this can be used to note an increment refers to trial credits, or
37223758
for noting corrections as a result of an incident, etc.
37233759
3724-
metadata: User-specified key/value pairs for the resource.
3760+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
3761+
by setting the value to `null`, and the entire metadata mapping can be cleared
3762+
by setting `metadata` to `null`.
37253763
37263764
void_reason: Can only be specified when `entry_type=void`. The reason for the void.
37273765
@@ -3876,7 +3914,9 @@ async def create_entry_by_external_id(
38763914
For example, this can be used to note an increment refers to trial credits, or
38773915
for noting corrections as a result of an incident, etc.
38783916
3879-
metadata: User-specified key/value pairs for the resource.
3917+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
3918+
by setting the value to `null`, and the entire metadata mapping can be cleared
3919+
by setting `metadata` to `null`.
38803920
38813921
extra_headers: Send extra headers
38823922

‎src/orb/resources/customers/customers.py

+18-6
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,9 @@ def create(
121121
system as an alias for this Customer. Use this field to identify a customer by
122122
an existing identifier in your system.
123123
124-
metadata: User-specified key/value pairs for the resource.
124+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
125+
by setting the value to `null`, and the entire metadata mapping can be cleared
126+
by setting `metadata` to `null`.
125127
126128
payment_provider: This is used for creating charges or invoices in an external system via Orb.
127129
When not in test mode, the connection must first be configured in the Orb
@@ -310,7 +312,9 @@ def update(
310312
311313
email: A valid customer email, to be used for invoicing and notifications.
312314
313-
metadata: User-specified key/value pairs for the resource.
315+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
316+
by setting the value to `null`, and the entire metadata mapping can be cleared
317+
by setting `metadata` to `null`.
314318
315319
name: The full name of the customer
316320
@@ -684,7 +688,9 @@ def update_by_external_id(
684688
685689
email: A valid customer email, to be used for invoicing and notifications.
686690
687-
metadata: User-specified key/value pairs for the resource.
691+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
692+
by setting the value to `null`, and the entire metadata mapping can be cleared
693+
by setting `metadata` to `null`.
688694
689695
name: The full name of the customer
690696
@@ -905,7 +911,9 @@ async def create(
905911
system as an alias for this Customer. Use this field to identify a customer by
906912
an existing identifier in your system.
907913
908-
metadata: User-specified key/value pairs for the resource.
914+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
915+
by setting the value to `null`, and the entire metadata mapping can be cleared
916+
by setting `metadata` to `null`.
909917
910918
payment_provider: This is used for creating charges or invoices in an external system via Orb.
911919
When not in test mode, the connection must first be configured in the Orb
@@ -1094,7 +1102,9 @@ async def update(
10941102
10951103
email: A valid customer email, to be used for invoicing and notifications.
10961104
1097-
metadata: User-specified key/value pairs for the resource.
1105+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
1106+
by setting the value to `null`, and the entire metadata mapping can be cleared
1107+
by setting `metadata` to `null`.
10981108
10991109
name: The full name of the customer
11001110
@@ -1468,7 +1478,9 @@ async def update_by_external_id(
14681478
14691479
email: A valid customer email, to be used for invoicing and notifications.
14701480
1471-
metadata: User-specified key/value pairs for the resource.
1481+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
1482+
by setting the value to `null`, and the entire metadata mapping can be cleared
1483+
by setting `metadata` to `null`.
14721484
14731485
name: The full name of the customer
14741486

‎src/orb/resources/metrics.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ def create(
6565
6666
sql: A sql string defining the metric.
6767
68-
metadata: User-specified key/value pairs for the resource.
68+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
69+
by setting the value to `null`, and the entire metadata mapping can be cleared
70+
by setting `metadata` to `null`.
6971
7072
extra_headers: Send extra headers
7173
@@ -229,7 +231,9 @@ async def create(
229231
230232
sql: A sql string defining the metric.
231233
232-
metadata: User-specified key/value pairs for the resource.
234+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
235+
by setting the value to `null`, and the entire metadata mapping can be cleared
236+
by setting `metadata` to `null`.
233237
234238
extra_headers: Send extra headers
235239

‎src/orb/resources/plans/external_plan_id.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,9 @@ def update(
6060
as an alias for this Plan. Use this field to identify a plan by an existing
6161
identifier in your system.
6262
63-
metadata: User-specified key/value pairs for the resource.
63+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
64+
by setting the value to `null`, and the entire metadata mapping can be cleared
65+
by setting `metadata` to `null`.
6466
6567
extra_headers: Send extra headers
6668
@@ -174,7 +176,9 @@ async def update(
174176
as an alias for this Plan. Use this field to identify a plan by an existing
175177
identifier in your system.
176178
177-
metadata: User-specified key/value pairs for the resource.
179+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
180+
by setting the value to `null`, and the entire metadata mapping can be cleared
181+
by setting `metadata` to `null`.
178182
179183
extra_headers: Send extra headers
180184

‎src/orb/resources/plans/plans.py

+12-4
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,9 @@ def create(
6767
6868
default_invoice_memo: Free-form text which is available on the invoice PDF and the Orb invoice portal.
6969
70-
metadata: User-specified key/value pairs for the resource.
70+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
71+
by setting the value to `null`, and the entire metadata mapping can be cleared
72+
by setting `metadata` to `null`.
7173
7274
net_terms: The net terms determines the difference between the invoice date and the issue
7375
date for the invoice. If you intend the invoice to be due on issue, set this
@@ -132,7 +134,9 @@ def update(
132134
as an alias for this Plan. Use this field to identify a plan by an existing
133135
identifier in your system.
134136
135-
metadata: User-specified key/value pairs for the resource.
137+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
138+
by setting the value to `null`, and the entire metadata mapping can be cleared
139+
by setting `metadata` to `null`.
136140
137141
extra_headers: Send extra headers
138142
@@ -314,7 +318,9 @@ async def create(
314318
315319
default_invoice_memo: Free-form text which is available on the invoice PDF and the Orb invoice portal.
316320
317-
metadata: User-specified key/value pairs for the resource.
321+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
322+
by setting the value to `null`, and the entire metadata mapping can be cleared
323+
by setting `metadata` to `null`.
318324
319325
net_terms: The net terms determines the difference between the invoice date and the issue
320326
date for the invoice. If you intend the invoice to be due on issue, set this
@@ -379,7 +385,9 @@ async def update(
379385
as an alias for this Plan. Use this field to identify a plan by an existing
380386
identifier in your system.
381387
382-
metadata: User-specified key/value pairs for the resource.
388+
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
389+
by setting the value to `null`, and the entire metadata mapping can be cleared
390+
by setting `metadata` to `null`.
383391
384392
extra_headers: Send extra headers
385393

0 commit comments

Comments
 (0)