magento 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cac0ea3cb60d8b0a55431e9b404ba17108ae038642e57c7908700915a109818
-  data.tar.gz: '098eb32b5b64f50fd1228245ec1b2f431f3512c47ec1b23c8583fc1b4cb18022'
+  metadata.gz: 77636870e263ab5add82976ce07571f75de8d2e70aa89d7e5a371366868e2400
+  data.tar.gz: 0ccf949f28c60fd7eefb8e3388429edeab872d18c9855088c5a6183b947dc9f7
 SHA512:
-  metadata.gz: 1125477eea00eafac5824a696777dea28b88dfe3bf9c0ea1161c2c98c286cbfa2198052669d6fbdb1b2041dc3fa987d4120167b1f4708859e1283ed018585d8b
-  data.tar.gz: 7db7a194488212a7d5b050d2c0acc5ec5f7f573995d291435a6a5743d39cba78320ea464f1fa2493f7672f59c5775f061f1fb9899be5ddb188b3dc9868a1c80b
+  metadata.gz: b685a13443e7c996a69a5079c29baccc26ff16fb3d6a630b94e07b21efec5f5f35a93ec36de7986f4881c36791d8a0cb59578cc1c7aaa7e29bf1393b5176a863
+  data.tar.gz: 97ff1f26eef308c00d19c608045eee47c2a43cc254ca3cfd6cc06fc59853aa16a16e23241f45cffe9aaa5cb7625b456c37dcd58d79dd1959ae155a748582c0dd

data/.gitignore

@@ -25,4 +25,4 @@ test/vcr_cassettes
 
 .vscode
 .byebug_history
-/*test.rb
+/manual_test

data/Gemfile

@@ -2,5 +2,5 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in pagarme.gemspec
+# Specify your gem's dependencies in magento.gemspec
 gemspec

data/README.md

@@ -1,561 +1,592 @@
-# Magento Ruby library
-
-## Install
-
-Add in your Gemfile
-
-```rb
-gem 'magento', '~> 0.12.0'
-```
-
-or run
-
-```sh
-gem install magento
-```
-
-### Setup
-
-```rb
-Magento.url   = 'https://yourstore.com'
-Magento.token = 'MAGENTO_API_KEY'
-Magento.store = :default # optional, Default is :all
-
-Magento.with_config(store: :other_store) do # accepts store, url and token parameters
-  Magento::Product.find('sku')
-end
-```
-
-## Models
-```rb
-Magento::Product
-Magento::Order
-Magento::Country
-Magento::Category
-Magento::Customer
-```
-
-## Get details
-
-```rb
-Magento::Product.find('sku-test')
-Magento::Order.find(25)
-Magento::Country.find('BR')
-```
-\* _same pattern to all models_
-
-**Outside pattern**
-
-Get customer by token
-
-```rb
-Magento::Customer.find_by_token('user_token')
-```
-
-## Get List
-
-```rb
-Magento::Product.all
-```
-
-#### Select fields:
-```rb
-Magento::Product.select(:id, :sku, :name).all
-Magento::Product.select(:id, :sku, :name, extension_attributes: :category_links).all
-Magento::Product.select(:id, :sku, :name, extension_attributes: [:category_links, :website_ids]).all
-Magento::Product.select(:id, :sku, :name, extension_attributes: [:website_ids, { category_links: :category_id }]).all
-```
-
-#### Filters:
-
-```rb
-Magento::Product.where(visibility: 4).all
-Magento::Product.where(name_like: 'IPhone%').all
-Magento::Product.where(price_gt: 100).all
-
-# price > 10 AND price < 20
-Magento::Product.where(price_gt: 10)
-                .where(price_lt: 20).all
-
-# price < 1 OR price > 100
-Magento::Product.where(price_lt: 1, price_gt: 100).all
-
-Magento::Order.where(status_in: [:canceled, :complete]).all
-```
-
-| Condition | Notes |
-| --------- | ----- |
-|eq         | Equals. |
-|finset     | A value within a set of values |
-|from       | The beginning of a range. Must be used with to |
-|gt         | Greater than |
-|gteq       | Greater than or equal |
-|in         | In. The value is an array |
-|like       | Like. The value can contain the SQL wildcard characters when like is specified. |
-|lt         | Less than |
-|lteq       | Less than or equal |
-|moreq      | More or equal |
-|neq        | Not equal |
-|nfinset    | A value that is not within a set of values |
-|nin        | Not in. The value is an array |
-|notnull    | Not null |
-|null       | Null |
-|to         | The end of a range. Must be used with from |
-
-
-#### SortOrder:
-
-```rb
-Magento::Product.order(:sku).all
-Magento::Product.order(sku: :desc).all
-Magento::Product.order(status: :desc, name: :asc).all
-```
-
-#### Pagination:
-
-```rb
-# Set page and quantity per page
-Magento::Product.page(1)       # Current page, Default is 1
-                .page_size(25) # Default is 50
-                .all
-
-# per is an alias to page_size
-Magento::Product.per(25).all
-```
-
-#### Example of several options together:
-```rb
-products = Magento::Product.select(:sku, :name)
-                           .where(name_like: 'biscoito%')
-                           .page(1)
-                           .page_size(5)
-                           .all
-```
-
-## Get one
-
-```rb
-Magento::Order.where(increment_id: '000013457').first
-# or
-Magento::Order.find_by(increment_id: '000013457')
-```
-
-## Count
-```rb
-Magento::Order.count
-Magento::Order.where(status: :pending).count
-```
-
-\* _same pattern to all models_
-
-### Response
-
-The `all` method retorns a `Magento::RecordCollection` instance
-
-```rb
-products.first
->> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
-
-products[0]
->> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
-
-products.last
->> <Magento::Product @sku="964", @name="Biscoito Negresco 140 G Original">
-
-products.map(&:sku)
->> ["2100", "792", "836", "913", "964"]
-
-products.size
->> 5
-
-products.current_page
->> 1
-
-products.next_page
->> 2
-
-products.last_page?
->> false
-
-products.page_size
->> 5
-
-products.total_count
->> 307
-
-products.filter_groups
->> [<Magento::FilterGroup @filters=[<Magento::Filter @field="name", @value="biscoito%", @condition_type="like">]>]
-```
-
-All Methods:
-
-```rb
-# Information about search criteria
-:current_page
-:next_page
-:last_page?
-:page_size
-:total_count
-:filter_groups
-
-# Iterating with the list of items
-:count
-:length
-:size
-
-:first
-:last
-:[]
-:find
-
-:each
-:each_with_index
-:sample
-
-:map
-:select
-:filter
-:reject
-:collect
-:take
-:take_while
-
-:sort
-:sort_by
-:reverse_each
-:reverse
-
-:all?
-:any?
-:none?
-:one?
-:empty?
-```
-
-## Create
-
-```rb
-Magento::Order.create(
-  customer_firstname: '',
-  customer_lastname: '',
-  customer_email: '',
-  # others attrbutes ...,
-  items: [
-    {
-      sku: '',
-      price: '',
-      qty_ordered: 1,
-      # others attrbutes ...,
-    }
-  ],
-  billing_address: {
-    # attrbutes...
-  },
-  payment: {
-    # attrbutes...
-  },
-  extension_attributes: {
-    # attrbutes...
-  }
-)
-```
-
-### Update
-
-```rb
-product = Magento::Product.find('sku-teste')
-
-product.name = 'Updated name'
-product.save
-
-# or
-
-product.update(name: 'Updated name')
-
-# or
-
-Magento::Product.update('sku-teste', name: 'Updated name')
-```
-
-### Delete
-
-```rb
-product = Magento::Product.find('sku-teste')
-
-product.delete
-
-# or
-
-Magento::Product.delete('sku-teste')
-```
-
-## GuestCart
-
-Set payment information to finish the order
-```rb
-cart = Magento::GuestCart.find('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7')
-
-# or use "build" to not request information from the magento API
-cart = Magento::GuestCart.build(
-  cart_id: 'aj8oUtY1Qi44Fror6UWVN7ftX1idbBKN'
-)
-
-cart.payment_information(
-  email: 'customer@gmail.com',
-  payment: { method: 'cashondelivery' }
-)
-
->> "234575" # return the order id
-```
-
-## Invoice an Order
-
-```rb
-Magento::Order.invoice(order_id)
->> 25 # return incoice id
-
-# or from instance
-
-order = Magento::Order.find(order_id)
-
-invoice_id = order.invoice
-
-# you can pass parameters too
-
-invoice_id = order.invoice(
-  capture: false,
-  appendComment: true,
-  items: [{ order_item_id: 123, qty: 1 }], # pass items to partial invoice
-  comment: {
-    extension_attributes: { },
-    comment: "string",
-    is_visible_on_front: 0
-  },
-  notify: true
-)
-```
-
-[Complete Invoice Documentation](https://magento.redoc.ly/2.4-admin/tag/orderorderIdinvoice#operation/salesInvoiceOrderV1ExecutePost)
-
-## Create refund for invoice
-
-```rb
-Magento::Invoice.invoice(invoice_id)
->> 12 # return refund id
-
-# or from instance
-
-invoice = Magento::Invoice.find(invoice_id)
-
-refund_id = invoice.refund
-
-# you can pass parameters too
-
-invoice.refund(
-  items: [
-    {
-      extension_attributes: {},
-      order_item_id: 0,
-      qty: 0
-    }
-  ],
-  isOnline: true,
-  notify: true,
-  appendComment: true,
-  comment: {
-    extension_attributes: {},
-    comment: string,
-    is_visible_on_front: 0
-  },
-  arguments: {
-    shipping_amount: 0,
-    adjustment_positive: 0,
-    adjustment_negative: 0,
-    extension_attributes: {
-      return_to_stock_items: [0]
-    }
-  }
-)
-```
-
-[Complete Refund Documentation](https://magento.redoc.ly/2.4-admin/tag/invoicescomments#operation/salesRefundInvoiceV1ExecutePost)
-
-
-## Create offline refund for order
-
-```rb
-Magento::Order.refund(order_id)
->> 12 # return refund id
-
-# or from instance
-
-order = Magento::Order.find(order_id)
-
-order.refund
-
-# you can pass parameters too
-
-order.refund(
-  items: [
-    {
-      extension_attributes: {},
-      order_item_id: 0,
-      qty: 0
-    }
-  ],
-  notify: true,
-  appendComment: true,
-  comment: {
-    extension_attributes: {},
-    comment: string,
-    is_visible_on_front: 0
-  },
-  arguments: {
-    shipping_amount: 0,
-    adjustment_positive: 0,
-    adjustment_negative: 0,
-    extension_attributes: {
-      return_to_stock_items: [0]
-    }
-  }
-)
-```
-
-[Complete Refund Documentation](https://magento.redoc.ly/2.4-admin/tag/invoicescomments#operation/salesRefundOrderV1ExecutePost)
-
-## Other Invoice methods
-
-```rb
-invoice = Magento::Invoice.find(invoice_id)
-
-invoice.capture # or
-Magento::Invoice.capture(invoice_id)
-
-invoice.void # or
-Magento::Invoice.void(invoice_id)
-
-invoice.send_email # or
-Magento::Invoice.send_email(invoice_id)
-
-Magento::Invoice.comments(invoice_id).all
-Magento::Invoice.comments(invoice_id).where(created_at_gt: Date.today.prev_day).all
-```
-
-## Creates new Shipment for given Order.
-
-```rb
-Magento::Order.ship(order_id)
->> 25 # return shipment id
-
-# or from instance
-
-order = Magento::Order.find(order_id)
-
-order.ship
-
-# you can pass parameters too
-
-order.ship(
-  capture: false,
-  appendComment: true,
-  items: [{ order_item_id: 123, qty: 1 }], # pass items to partial shipment
-  tracks: [
-    {
-      extension_attributes: { },
-      track_number: "string",
-      title: "string",
-      carrier_code: "string"
-    }
-  ]
-  notify: true
-)
-```
-
-[Complete Shipment Documentation](https://magento.redoc.ly/2.4-admin/tag/orderorderIdship#operation/salesShipOrderV1ExecutePost)
-
-
-## Cancel an Order
-
-```rb
-order = Magento::Order.find(order_id)
-
-order.cancel # or
-
-Magento::Order.cancel(order_id)
-```
-
-## Generate Sales Rules and Coupons
-
-```rb
-rule = Magento::SalesRule.create(
-  name: 'Discount name',
-  website_ids: [1],
-  customer_group_ids: [0,1,2,3],
-  uses_per_customer: 1,
-  is_active: true,
-  stop_rules_processing: true,
-  is_advanced: false,
-  sort_order: 0,
-  discount_amount: 100,
-  discount_step: 1,
-  apply_to_shipping: true,
-  times_used: 0,
-  is_rss: true,
-  coupon_type: 'specific',
-  use_auto_generation: true,
-  uses_per_coupon: 1
-)
-
-rule.generate_coupon(quantity: 1, length: 10)
-```
-
-Renarate by class method
-```rb
-Magento::SalesRule.generate_coupon(
-  couponSpec: {
-    rule_id: 7,
-    quantity: 1,
-    length: 10
-  }
-)
-```
-see all params in:
-- [Magento docs Coupon](https://magento.redoc.ly/2.3.5-admin/tag/couponsgenerate#operation/salesRuleCouponManagementV1GeneratePost)
-- [Magento docs SalesRules](https://magento.redoc.ly/2.3.5-admin/tag/salesRules#operation/salesRuleRuleRepositoryV1SavePost)
-
-### First result
-```rb
-Magento::Product.first
->> <Magento::Product @sku="some-sku" ...>
-
-Magento::Product.where(name_like: 'some name%').first
->> <Magento::Product @sku="some-sku" ...>
-```
-
-### Count result
-```rb
-Magento::Product.count
->> 7855
-Magento::Product.where(name_like: 'some name%').count
->> 15
-```
-
-___
-
-##TODO:
-
-### Search products
-```rb
-Magento::Product.search('tshort')
-```
-
-### Last result
-```rb
-Magento::Product.last
->> <Magento::Product @sku="some-sku" ...>
-
-Magento::Product.where(name_like: 'some name%').last
->> <Magento::Product @sku="some-sku" ...>
-```
-
-### Tests
+# Magento Ruby library
+
+## Install
+
+Add in your Gemfile
+
+```rb
+gem 'magento', '~> 0.13.0'
+```
+
+or run
+
+```sh
+gem install magento
+```
+
+### Setup
+
+```rb
+Magento.url   = 'https://yourstore.com'
+Magento.token = 'MAGENTO_API_KEY'
+Magento.store = :default # optional, Default is :all
+
+Magento.with_config(store: :other_store) do # accepts store, url and token parameters
+  Magento::Product.find('sku')
+end
+```
+
+## Models
+```rb
+Magento::Product
+Magento::Order
+Magento::Country
+Magento::Category
+Magento::Customer
+```
+
+## Get details
+
+```rb
+Magento::Product.find('sku-test')
+Magento::Order.find(25)
+Magento::Country.find('BR')
+```
+\* _same pattern to all models_
+
+**Outside pattern**
+
+Get customer by token
+
+```rb
+Magento::Customer.find_by_token('user_token')
+```
+
+## Shurtcut to get custom attribute value by custom attribute code in product
+
+Exemple:
+
+```rb
+product.attr :description 
+# it is the same as
+product.custom_attributes.find { |a| a.attribute_code == 'description' }&.value
+
+# or
+product.description
+```
+
+when the custom attribute does not exists:
+
+```rb
+product.attr :special_price
+> nil
+
+product.special_price
+> NoMethodError: undefined method `special_price' for #<Magento::Product:...>
+```
+
+```rb
+product.respond_to? :special_price
+> false
+
+product.respond_to? :description
+> true
+```
+
+## Get List
+
+```rb
+Magento::Product.all
+```
+
+#### Select fields:
+```rb
+Magento::Product.select(:id, :sku, :name).all
+Magento::Product.select(:id, :sku, :name, extension_attributes: :category_links).all
+Magento::Product.select(:id, :sku, :name, extension_attributes: [:category_links, :website_ids]).all
+Magento::Product.select(:id, :sku, :name, extension_attributes: [:website_ids, { category_links: :category_id }]).all
+```
+
+#### Filters:
+
+```rb
+Magento::Product.where(visibility: 4).all
+Magento::Product.where(name_like: 'IPhone%').all
+Magento::Product.where(price_gt: 100).all
+
+# price > 10 AND price < 20
+Magento::Product.where(price_gt: 10)
+                .where(price_lt: 20).all
+
+# price < 1 OR price > 100
+Magento::Product.where(price_lt: 1, price_gt: 100).all
+
+Magento::Order.where(status_in: [:canceled, :complete]).all
+```
+
+| Condition | Notes |
+| --------- | ----- |
+|eq         | Equals. |
+|finset     | A value within a set of values |
+|from       | The beginning of a range. Must be used with to |
+|gt         | Greater than |
+|gteq       | Greater than or equal |
+|in         | In. The value is an array |
+|like       | Like. The value can contain the SQL wildcard characters when like is specified. |
+|lt         | Less than |
+|lteq       | Less than or equal |
+|moreq      | More or equal |
+|neq        | Not equal |
+|nfinset    | A value that is not within a set of values |
+|nin        | Not in. The value is an array |
+|notnull    | Not null |
+|null       | Null |
+|to         | The end of a range. Must be used with from |
+
+
+#### SortOrder:
+
+```rb
+Magento::Product.order(:sku).all
+Magento::Product.order(sku: :desc).all
+Magento::Product.order(status: :desc, name: :asc).all
+```
+
+#### Pagination:
+
+```rb
+# Set page and quantity per page
+Magento::Product.page(1)       # Current page, Default is 1
+                .page_size(25) # Default is 50
+                .all
+
+# per is an alias to page_size
+Magento::Product.per(25).all
+```
+
+#### Example of several options together:
+```rb
+products = Magento::Product.select(:sku, :name)
+                           .where(name_like: 'biscoito%')
+                           .page(1)
+                           .page_size(5)
+                           .all
+```
+
+## Get one
+
+```rb
+Magento::Order.where(increment_id: '000013457').first
+# or
+Magento::Order.find_by(increment_id: '000013457')
+```
+
+## Count
+```rb
+Magento::Order.count
+Magento::Order.where(status: :pending).count
+```
+
+\* _same pattern to all models_
+
+### Response
+
+The `all` method retorns a `Magento::RecordCollection` instance
+
+```rb
+products.first
+>> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
+
+products[0]
+>> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
+
+products.last
+>> <Magento::Product @sku="964", @name="Biscoito Negresco 140 G Original">
+
+products.map(&:sku)
+>> ["2100", "792", "836", "913", "964"]
+
+products.size
+>> 5
+
+products.current_page
+>> 1
+
+products.next_page
+>> 2
+
+products.last_page?
+>> false
+
+products.page_size
+>> 5
+
+products.total_count
+>> 307
+
+products.filter_groups
+>> [<Magento::FilterGroup @filters=[<Magento::Filter @field="name", @value="biscoito%", @condition_type="like">]>]
+```
+
+All Methods:
+
+```rb
+# Information about search criteria
+:current_page
+:next_page
+:last_page?
+:page_size
+:total_count
+:filter_groups
+
+# Iterating with the list of items
+:count
+:length
+:size
+
+:first
+:last
+:[]
+:find
+
+:each
+:each_with_index
+:sample
+
+:map
+:select
+:filter
+:reject
+:collect
+:take
+:take_while
+
+:sort
+:sort_by
+:reverse_each
+:reverse
+
+:all?
+:any?
+:none?
+:one?
+:empty?
+```
+
+## Create
+
+```rb
+Magento::Order.create(
+  customer_firstname: '',
+  customer_lastname: '',
+  customer_email: '',
+  # others attrbutes ...,
+  items: [
+    {
+      sku: '',
+      price: '',
+      qty_ordered: 1,
+      # others attrbutes ...,
+    }
+  ],
+  billing_address: {
+    # attrbutes...
+  },
+  payment: {
+    # attrbutes...
+  },
+  extension_attributes: {
+    # attrbutes...
+  }
+)
+```
+
+### Update
+
+```rb
+product = Magento::Product.find('sku-teste')
+
+product.name = 'Updated name'
+product.save
+
+# or
+
+product.update(name: 'Updated name')
+
+# or
+
+Magento::Product.update('sku-teste', name: 'Updated name')
+```
+
+### Delete
+
+```rb
+product = Magento::Product.find('sku-teste')
+
+product.delete
+
+# or
+
+Magento::Product.delete('sku-teste')
+```
+
+## GuestCart
+
+Set payment information to finish the order
+```rb
+cart = Magento::GuestCart.find('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7')
+
+# or use "build" to not request information from the magento API
+cart = Magento::GuestCart.build(
+  cart_id: 'aj8oUtY1Qi44Fror6UWVN7ftX1idbBKN'
+)
+
+cart.payment_information(
+  email: 'customer@gmail.com',
+  payment: { method: 'cashondelivery' }
+)
+
+>> "234575" # return the order id
+```
+
+## Invoice an Order
+
+```rb
+Magento::Order.invoice(order_id)
+>> 25 # return incoice id
+
+# or from instance
+
+order = Magento::Order.find(order_id)
+
+invoice_id = order.invoice
+
+# you can pass parameters too
+
+invoice_id = order.invoice(
+  capture: false,
+  appendComment: true,
+  items: [{ order_item_id: 123, qty: 1 }], # pass items to partial invoice
+  comment: {
+    extension_attributes: { },
+    comment: "string",
+    is_visible_on_front: 0
+  },
+  notify: true
+)
+```
+
+[Complete Invoice Documentation](https://magento.redoc.ly/2.4-admin/tag/orderorderIdinvoice#operation/salesInvoiceOrderV1ExecutePost)
+
+## Create refund for invoice
+
+```rb
+Magento::Invoice.invoice(invoice_id)
+>> 12 # return refund id
+
+# or from instance
+
+invoice = Magento::Invoice.find(invoice_id)
+
+refund_id = invoice.refund
+
+# you can pass parameters too
+
+invoice.refund(
+  items: [
+    {
+      extension_attributes: {},
+      order_item_id: 0,
+      qty: 0
+    }
+  ],
+  isOnline: true,
+  notify: true,
+  appendComment: true,
+  comment: {
+    extension_attributes: {},
+    comment: string,
+    is_visible_on_front: 0
+  },
+  arguments: {
+    shipping_amount: 0,
+    adjustment_positive: 0,
+    adjustment_negative: 0,
+    extension_attributes: {
+      return_to_stock_items: [0]
+    }
+  }
+)
+```
+
+[Complete Refund Documentation](https://magento.redoc.ly/2.4-admin/tag/invoicescomments#operation/salesRefundInvoiceV1ExecutePost)
+
+
+## Create offline refund for order
+
+```rb
+Magento::Order.refund(order_id)
+>> 12 # return refund id
+
+# or from instance
+
+order = Magento::Order.find(order_id)
+
+order.refund
+
+# you can pass parameters too
+
+order.refund(
+  items: [
+    {
+      extension_attributes: {},
+      order_item_id: 0,
+      qty: 0
+    }
+  ],
+  notify: true,
+  appendComment: true,
+  comment: {
+    extension_attributes: {},
+    comment: string,
+    is_visible_on_front: 0
+  },
+  arguments: {
+    shipping_amount: 0,
+    adjustment_positive: 0,
+    adjustment_negative: 0,
+    extension_attributes: {
+      return_to_stock_items: [0]
+    }
+  }
+)
+```
+
+[Complete Refund Documentation](https://magento.redoc.ly/2.4-admin/tag/invoicescomments#operation/salesRefundOrderV1ExecutePost)
+
+## Other Invoice methods
+
+```rb
+invoice = Magento::Invoice.find(invoice_id)
+
+invoice.capture # or
+Magento::Invoice.capture(invoice_id)
+
+invoice.void # or
+Magento::Invoice.void(invoice_id)
+
+invoice.send_email # or
+Magento::Invoice.send_email(invoice_id)
+
+Magento::Invoice.comments(invoice_id).all
+Magento::Invoice.comments(invoice_id).where(created_at_gt: Date.today.prev_day).all
+```
+
+## Creates new Shipment for given Order.
+
+```rb
+Magento::Order.ship(order_id)
+>> 25 # return shipment id
+
+# or from instance
+
+order = Magento::Order.find(order_id)
+
+order.ship
+
+# you can pass parameters too
+
+order.ship(
+  capture: false,
+  appendComment: true,
+  items: [{ order_item_id: 123, qty: 1 }], # pass items to partial shipment
+  tracks: [
+    {
+      extension_attributes: { },
+      track_number: "string",
+      title: "string",
+      carrier_code: "string"
+    }
+  ]
+  notify: true
+)
+```
+
+[Complete Shipment Documentation](https://magento.redoc.ly/2.4-admin/tag/orderorderIdship#operation/salesShipOrderV1ExecutePost)
+
+
+## Cancel an Order
+
+```rb
+order = Magento::Order.find(order_id)
+
+order.cancel # or
+
+Magento::Order.cancel(order_id)
+```
+
+## Generate Sales Rules and Coupons
+
+```rb
+rule = Magento::SalesRule.create(
+  name: 'Discount name',
+  website_ids: [1],
+  customer_group_ids: [0,1,2,3],
+  uses_per_customer: 1,
+  is_active: true,
+  stop_rules_processing: true,
+  is_advanced: false,
+  sort_order: 0,
+  discount_amount: 100,
+  discount_step: 1,
+  apply_to_shipping: true,
+  times_used: 0,
+  is_rss: true,
+  coupon_type: 'specific',
+  use_auto_generation: true,
+  uses_per_coupon: 1
+)
+
+rule.generate_coupon(quantity: 1, length: 10)
+```
+
+Renarate by class method
+```rb
+Magento::SalesRule.generate_coupon(
+  couponSpec: {
+    rule_id: 7,
+    quantity: 1,
+    length: 10
+  }
+)
+```
+see all params in:
+- [Magento docs Coupon](https://magento.redoc.ly/2.3.5-admin/tag/couponsgenerate#operation/salesRuleCouponManagementV1GeneratePost)
+- [Magento docs SalesRules](https://magento.redoc.ly/2.3.5-admin/tag/salesRules#operation/salesRuleRuleRepositoryV1SavePost)
+
+### First result
+```rb
+Magento::Product.first
+>> <Magento::Product @sku="some-sku" ...>
+
+Magento::Product.where(name_like: 'some name%').first
+>> <Magento::Product @sku="some-sku" ...>
+```
+
+### Count result
+```rb
+Magento::Product.count
+>> 7855
+Magento::Product.where(name_like: 'some name%').count
+>> 15
+```
+
+___
+
+##TODO:
+
+### Search products
+```rb
+Magento::Product.search('tshort')
+```
+
+### Last result
+```rb
+Magento::Product.last
+>> <Magento::Product @sku="some-sku" ...>
+
+Magento::Product.where(name_like: 'some name%').last
+>> <Magento::Product @sku="some-sku" ...>
+```
+
+### Tests