Skip to content

docs(api): update metadata docstrings #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 23, 2023
Merged

docs(api): update metadata docstrings #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 60 additions & 20 deletions src/orb/resources/customers/credits/ledger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,9 @@ def create_entry(
per_unit_cost_basis, as the calculation of the invoice total is done on that
basis.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

per_unit_cost_basis: Can only be specified when entry_type=increment. How much, in USD, a customer
paid for a single credit in this block
Expand Down Expand Up @@ -499,7 +501,9 @@ def create_entry(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -662,7 +666,9 @@ def create_entry(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -816,7 +822,9 @@ def create_entry(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

void_reason: Can only be specified when `entry_type=void`. The reason for the void.

Expand Down Expand Up @@ -971,7 +979,9 @@ def create_entry(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -1207,7 +1217,9 @@ def create_entry_by_external_id(
per_unit_cost_basis, as the calculation of the invoice total is done on that
basis.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

per_unit_cost_basis: Can only be specified when entry_type=increment. How much, in USD, a customer
paid for a single credit in this block
Expand Down Expand Up @@ -1360,7 +1372,9 @@ def create_entry_by_external_id(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -1523,7 +1537,9 @@ def create_entry_by_external_id(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -1677,7 +1693,9 @@ def create_entry_by_external_id(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

void_reason: Can only be specified when `entry_type=void`. The reason for the void.

Expand Down Expand Up @@ -1832,7 +1850,9 @@ def create_entry_by_external_id(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -2390,7 +2410,9 @@ async def create_entry(
per_unit_cost_basis, as the calculation of the invoice total is done on that
basis.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

per_unit_cost_basis: Can only be specified when entry_type=increment. How much, in USD, a customer
paid for a single credit in this block
Expand Down Expand Up @@ -2543,7 +2565,9 @@ async def create_entry(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -2706,7 +2730,9 @@ async def create_entry(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -2860,7 +2886,9 @@ async def create_entry(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

void_reason: Can only be specified when `entry_type=void`. The reason for the void.

Expand Down Expand Up @@ -3015,7 +3043,9 @@ async def create_entry(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -3251,7 +3281,9 @@ async def create_entry_by_external_id(
per_unit_cost_basis, as the calculation of the invoice total is done on that
basis.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

per_unit_cost_basis: Can only be specified when entry_type=increment. How much, in USD, a customer
paid for a single credit in this block
Expand Down Expand Up @@ -3404,7 +3436,9 @@ async def create_entry_by_external_id(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -3567,7 +3601,9 @@ async def create_entry_by_external_id(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -3721,7 +3757,9 @@ async def create_entry_by_external_id(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

void_reason: Can only be specified when `entry_type=void`. The reason for the void.

Expand Down Expand Up @@ -3876,7 +3914,9 @@ async def create_entry_by_external_id(
For example, this can be used to note an increment refers to trial credits, or
for noting corrections as a result of an incident, etc.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down
24 changes: 18 additions & 6 deletions src/orb/resources/customers/customers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,9 @@ def create(
system as an alias for this Customer. Use this field to identify a customer by
an existing identifier in your system.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

payment_provider: This is used for creating charges or invoices in an external system via Orb.
When not in test mode, the connection must first be configured in the Orb
Expand Down Expand Up @@ -310,7 +312,9 @@ def update(

email: A valid customer email, to be used for invoicing and notifications.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

name: The full name of the customer

Expand Down Expand Up @@ -684,7 +688,9 @@ def update_by_external_id(

email: A valid customer email, to be used for invoicing and notifications.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

name: The full name of the customer

Expand Down Expand Up @@ -905,7 +911,9 @@ async def create(
system as an alias for this Customer. Use this field to identify a customer by
an existing identifier in your system.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

payment_provider: This is used for creating charges or invoices in an external system via Orb.
When not in test mode, the connection must first be configured in the Orb
Expand Down Expand Up @@ -1094,7 +1102,9 @@ async def update(

email: A valid customer email, to be used for invoicing and notifications.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

name: The full name of the customer

Expand Down Expand Up @@ -1468,7 +1478,9 @@ async def update_by_external_id(

email: A valid customer email, to be used for invoicing and notifications.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

name: The full name of the customer

Expand Down
8 changes: 6 additions & 2 deletions src/orb/resources/metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ def create(

sql: A sql string defining the metric.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -229,7 +231,9 @@ async def create(

sql: A sql string defining the metric.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down
8 changes: 6 additions & 2 deletions src/orb/resources/plans/external_plan_id.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,9 @@ def update(
as an alias for this Plan. Use this field to identify a plan by an existing
identifier in your system.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -174,7 +176,9 @@ async def update(
as an alias for this Plan. Use this field to identify a plan by an existing
identifier in your system.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down
16 changes: 12 additions & 4 deletions src/orb/resources/plans/plans.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,9 @@ def create(

default_invoice_memo: Free-form text which is available on the invoice PDF and the Orb invoice portal.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

net_terms: The net terms determines the difference between the invoice date and the issue
date for the invoice. If you intend the invoice to be due on issue, set this
Expand Down Expand Up @@ -132,7 +134,9 @@ def update(
as an alias for this Plan. Use this field to identify a plan by an existing
identifier in your system.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down Expand Up @@ -314,7 +318,9 @@ async def create(

default_invoice_memo: Free-form text which is available on the invoice PDF and the Orb invoice portal.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

net_terms: The net terms determines the difference between the invoice date and the issue
date for the invoice. If you intend the invoice to be due on issue, set this
Expand Down Expand Up @@ -379,7 +385,9 @@ async def update(
as an alias for this Plan. Use this field to identify a plan by an existing
identifier in your system.

metadata: User-specified key/value pairs for the resource.
metadata: User-specified key/value pairs for the resource. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can be cleared
by setting `metadata` to `null`.

extra_headers: Send extra headers

Expand Down
Loading