Skip to content
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

Merged
merged 2 commits into from
Jun 17, 2024
Merged

[DE-846] Release v0.2.1 #27

merged 2 commits into from
Jun 17, 2024

Conversation

maciej-nedza
Copy link
Contributor

@maciej-nedza maciej-nedza commented Jun 17, 2024

  • Provided default values for domain and subdomain client parameters
  • Fixed array form query parameters serialization

Summary by CodeRabbit

  • New Features

    • Added configuration settings for subdomain and domain parameters in the API client initialization.
  • Improvements

    • Clarified that the Organization field in the customer model will default to the customer's first and last name if no value is provided.
    • Updated user agent string for better version tracking.
  • Dependencies

    • Upgraded github.com/apimatic/go-core-runtime dependency to version v0.0.22.
  • Documentation

    • Updated README and client documentation to reflect new configuration options and version changes.
  • Tests

    • Enhanced InvoiceSuite test by specifying invoice event types for better test coverage.

Copy link

coderabbitai bot commented Jun 17, 2024

Walkthrough

The changes primarily update version references and introduce new configuration options within the advancedbilling library. Specifically, the package version is raised from v0.2.0 to v0.2.1 across various files. Additionally, new configuration settings for subdomain and domain parameters are added for API client initialization. User agent strings and dependencies in go.mod are also updated. Lastly, documentation for customer models is refined to specify default behaviors for the Organization field.

Changes

File Change Summary
README.md Updated package version to v0.2.1 and added subdomain/domain configuration settings.
client.go Updated user agent string to reflect new version v0.2.1.
doc/client.md Added WithSubdomain and WithDomain configuration example to the client initialization.
doc/models/customer.md Updated Organization field description to specify default behavior when not provided.
models/customer.go Enhanced comment for Organization field in Customer struct for default population behavior.
go.mod / test/go.mod Updated github.com/apimatic/go-core-runtime dependency from v0.0.21 to v0.0.22.
test/invoice_test.go Added EventTypes parameter to the ListInvoiceEvents method call in InvoiceSuite test.

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
Loading

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

swarmia bot commented Jun 17, 2024

Copy link

@coderabbitai coderabbitai bot left a 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 used

README.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

Commits

Files that changed from the base of the PR and between cc42c65 and 6a4cb48.

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 lines

doc/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 used

README.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 the subdomain and domain 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 the Organization 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 the subdomain and domain 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 and VOIDINVOICE) in the test case for listing invoice events aligns with the PR's objectives to improve the serialization of array form query parameters.

@maciej-nedza maciej-nedza merged commit c6c901f into main Jun 17, 2024
1 check passed
@maciej-nedza maciej-nedza deleted the 0.2.1 branch June 17, 2024 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants