-
Notifications
You must be signed in to change notification settings - Fork 1
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.
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
[DE-846] Release v0.2.1 #27
Conversation
WalkthroughThe changes primarily update version references and introduce new configuration options within the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant AdvancedBillingClient as API Client
participant AdvancedBillingService
User->>AdvancedBillingClient: Initialize with subdomain and domain
AdvancedBillingClient->>AdvancedBillingService: API request with User-Agent "AB SDK Go:0.2.1"
AdvancedBillingService->>AdvancedBillingClient: Response
AdvancedBillingClient->>User: Result
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
✅ Linked to Task DE-846 · Regenerate and publish Go sdk with fixed form query parameters formatting |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Outside diff range and nitpick comments (3)
doc/client.md (1)
Line range hint
77-77
: Remove the extra blank line to adhere to Markdown best practices.-
doc/models/customer.md (1)
Line range hint
52-52
: Remove the extra blank line to maintain consistency and cleanliness in the Markdown file.-
Tools
Markdownlint
15-15: null (MD034, no-bare-urls)
Bare URL used
15-15: null (MD034, no-bare-urls)
Bare URL usedREADME.md (1)
Line range hint
139-139
: Remove the extra blank line to adhere to Markdown formatting standards.-
Tools
Markdownlint
41-41: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
44-44: null (MD034, no-bare-urls)
Bare URL used
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (2)
go.sum
is excluded by!**/*.sum
test/go.sum
is excluded by!**/*.sum
Files selected for processing (8)
- README.md (2 hunks)
- client.go (1 hunks)
- doc/client.md (1 hunks)
- doc/models/customer.md (1 hunks)
- go.mod (1 hunks)
- models/customer.go (1 hunks)
- test/go.mod (1 hunks)
- test/invoice_test.go (1 hunks)
Files skipped from review due to trivial changes (4)
- client.go
- go.mod
- models/customer.go
- test/go.mod
Additional context used
Markdownlint
doc/client.md
77-77: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank linesdoc/models/customer.md
52-52: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
15-15: null (MD034, no-bare-urls)
Bare URL used
15-15: null (MD034, no-bare-urls)
Bare URL usedREADME.md
139-139: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
41-41: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
26-26: null (MD034, no-bare-urls)
Bare URL used
44-44: null (MD034, no-bare-urls)
Bare URL used
24-24: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
54-54: Expected: underscore; Actual: asterisk (MD049, emphasis-style)
Emphasis style
54-54: Expected: underscore; Actual: asterisk (MD049, emphasis-style)
Emphasis style
55-55: Expected: underscore; Actual: asterisk (MD049, emphasis-style)
Emphasis style
55-55: Expected: underscore; Actual: asterisk (MD049, emphasis-style)
Emphasis style
LanguageTool
doc/models/customer.md
[misspelling] ~34-~34: This word is normally spelled with a hyphen. (EN_COMPOUNDS_TAX_EXEMPT)
Context: ...TaxExempt
|*bool
| Optional | The tax exempt status for the customer. Acceptable val...
[grammar] ~35-~35: When ‘opt-out’ is used as a modifier, it is usually spelled with a hyphen. (OPT_IN_HYPHEN)
Context: ...his number is used to determine VAT tax opt out rules. It is not validated when added o...README.md
[uncategorized] ~8-~8: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...d format, but XML is also provided as a backwards compatible option for Merchants who require it. #...
[uncategorized] ~110-~110: The Latin adjective/adverb “pro forma” is spelled as two words. (PRO_RATA)
Context: ...controllers/product-price-points.md) * [Proforma Invoices](doc/controllers/proforma-invo...
Additional comments not posted (5)
doc/client.md (1)
31-32
: The addition of default values for thesubdomain
anddomain
parameters in the client initialization example is consistent with the PR's objectives. This will help users understand how to use these configurations.doc/models/customer.md (1)
16-16
: The updated description for theOrganization
field clarifies the default behavior when no value is provided. This is a useful detail for API consumers.README.md (2)
41-41
: The updated package installation command and URL correctly reflect the new version (v0.2.1). This ensures users download the correct version of the SDK.Also applies to: 44-44
Tools
Markdownlint
41-41: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
77-78
: The addition of default values for thesubdomain
anddomain
parameters in the API client initialization is consistent with the PR's objectives and provides clarity on default configurations.test/invoice_test.go (1)
99-100
: The addition of specific event types (ISSUEINVOICE
andVOIDINVOICE
) in the test case for listing invoice events aligns with the PR's objectives to improve the serialization of array form query parameters.
Summary by CodeRabbit
New Features
Improvements
Organization
field in the customer model will default to the customer's first and last name if no value is provided.Dependencies
github.com/apimatic/go-core-runtime
dependency to versionv0.0.22
.Documentation
Tests
InvoiceSuite
test by specifying invoice event types for better test coverage.