starkinfra 0.1.0 → 0.3.0

data/lib/{issuingbin/issuingbin.rb → issuingproduct/issuingproduct.rb}

@@ -1,45 +1,43 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
-  # # IssuingBin object
+  # # IssuingProduct object
   #
-  # The IssuingBin object displays information of BINs registered to your Workspace.
-  # They represent a group of cards that begin with the same numbers (BIN) and offer the same product to end customers.
+  # The IssuingProduct object displays information of registered card products to your Workspace.
+  # They represent a group of cards that begin with the same numbers (id) and offer the same product to end customers.
   #
   # ## Attributes (return-only):
-  # - id [string]: unique BIN number registered within the card network. ex: '53810200'
+  # - id [string]: unique card product number (BIN) registered within the card network. ex: '53810200'
   # - network [string]: card network flag. ex: 'mastercard'
-  # - settlement [string]: settlement type. ex: 'credit'
-  # - category [string]: purchase category. ex: 'prepaid'
-  # - client [string]: client type. ex: 'business'
-  # - created [DateTime]: creation datetime for the IssuingBin. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - updated [DateTime]: latest update datetime for the IssuingBin. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  class IssuingBin < StarkInfra::Utils::Resource
-    attr_reader :id, :network, :settlement, :category, :client, :updated, :created
-    def initialize(id: nil, network: nil, settlement: nil, category: nil, client: nil, updated: nil, created: nil)
+  # - funding_type [string]: type of funding used for payment. ex: 'credit', 'debit'
+  # - holder_type [string]: holder type. ex: 'business', 'individual'
+  # - code [string]: internal code from card flag informing the product. ex: 'MRW', 'MCO', 'MWB', 'MCS'
+  # - created [DateTime]: creation datetime for the IssuingProduct. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class IssuingProduct < StarkInfra::Utils::Resource
+    attr_reader :id, :network, :funding_type, :holder_type, :code, :created
+    def initialize(id: nil, network: nil, funding_type: nil, holder_type: nil, code: nil, created: nil)
       super(id)
       @network = network
-      @settlement = settlement
-      @category = category
-      @client = client
-      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+      @funding_type = funding_type
+      @holder_type = holder_type
+      @code = code
       @created = StarkInfra::Utils::Checks.check_datetime(created)
     end
 
-    # # Retrieve the IssuingBin object
+    # # Retrieve IssuingProducts
     #
-    # Receive a generator of IssuingBin objects previously registered in the Stark Infra API
+    # Receive a generator of IssuingProduct objects previously registered in the Stark Infra API
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - generator of IssuingBin objects with updated attributes
+    # - generator of IssuingProduct objects with updated attributes
     def self.query(limit: nil, user: nil)
       StarkInfra::Utils::Rest.get_stream(
         limit: limit,
@@ -48,9 +46,9 @@ module StarkInfra
       )
     end
 
-    # # Retrieve paged IssuingBins
+    # # Retrieve paged IssuingProducts
     #
-    # Receive a list of up to 100 IssuingBin objects previously registered in the Stark Infra API and the cursor to the next page.
+    # Receive a list of up to 100 IssuingProduct objects previously registered to your workspace and the cursor to the next page.
     #
     # ## Parameters (optional):
     # - cursor [string, default nil]: cursor returned on the previous page function call.
@@ -58,8 +56,8 @@ module StarkInfra
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - list of IssuingBin objects with updated attributes
-    # - cursor to retrieve the next page of IssuingBin objects
+    # - list of IssuingProduct objects with updated attributes
+    # - cursor to retrieve the next page of IssuingProduct objects
     def self.page(cursor: nil, limit: nil, user: nil)
       StarkInfra::Utils::Rest.get_page(
         cursor: cursor,
@@ -71,15 +69,14 @@ module StarkInfra
 
     def self.resource
       {
-        resource_name: 'IssuingBin',
+        resource_name: 'IssuingProduct',
         resource_maker: proc { |json|
-          IssuingBin.new(
+          IssuingProduct.new(
             id: json['id'],
             network: json['network'],
-            settlement: json['settlement'],
-            category: json['category'],
-            client: json['client'],
-            updated: json['updated'],
+            funding_type: json['funding_type'],
+            holder_type: json['holder_type'],
+            code: json['code'],
             created: json['created']
           )
         }

data/lib/issuingpurchase/issuingpurchase.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # IssuingPurchase object
@@ -12,8 +12,10 @@ module StarkInfra
   # ## Attributes (return-only):
   # - id [string]: unique id returned when IssuingPurchase is created. ex: '5656565656565656'
   # - holder_name [string]: card holder name. ex: 'Tony Stark'
+  # - product_id [string]: unique card product number (BIN) registered within the card network. ex: "53810200"
   # - card_id [string]: unique id returned when IssuingCard is created. ex: '5656565656565656'
   # - card_ending [string]: last 4 digits of the card number. ex: '1234'
+  # - purpose [string]: purchase purpose. ex: 'purchase'
   # - amount [integer]: IssuingPurchase value in cents. Minimum = 0. ex: 1234 (= R$ 12.34)
   # - tax [integer]: IOF amount taxed for international purchases. ex: 1234 (= R$ 12.34)
   # - issuer_amount [integer]: issuer amount. ex: 1234 (= R$ 12.34)
@@ -29,32 +31,43 @@ module StarkInfra
   # - merchant_name [string]: merchant name. ex: 'Google Cloud Platform'
   # - merchant_fee [integer]: fee charged by the merchant to cover specific costs, such as ATM withdrawal logistics, etc. ex: 200 (= R$ 2.00)
   # - wallet_id [string]: virtual wallet ID. ex: '5656565656565656'
-  # - method_code [string]: method code. ex: 'chip', 'token', 'server', 'manual', 'magstripe' or 'contactless'
+  # - method_code [string]: method code. Options: 'chip', 'token', 'server', 'manual', 'magstripe' or 'contactless'
   # - score [float]: internal score calculated for the authenticity of the purchase. nil in case of insufficient data. ex: 7.6
-  # - issuing_transaction_ids [string]: ledger transaction ids linked to this Purchase
-  # - end_to_end_id [string]: Unique id used to identify the transaction through all of its life cycle, even before the purchase is denied or accepted and gets its usual id. Example: endToEndId='679cd385-642b-49d0-96b7-89491e1249a5'
-  # - status [string]: current IssuingCard status. ex: 'approved', 'canceled', 'denied', 'confirmed', 'voided'
+  # - end_to_end_id [string]: Unique id used to identify the transaction through all of its life cycle, even before the purchase is denied or approved and gets its usual id. ex: '679cd385-642b-49d0-96b7-89491e1249a5'
   # - tags [string]: list of strings for tagging returned by the sub-issuer during the authorization. ex: ['travel', 'food']
-  # - created [DateTime]: creation datetime for the IssuingPurchase. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - zip_code [string]: zip code of the merchant location. ex: '02101234'
+  #
+  # ## Attributes (IssuingPurchase only):
+  # - issuing_transaction_ids [string]: ledger transaction ids linked to this Purchase
+  # - status [string]: current IssuingCard status. Options: 'approved', 'canceled', 'denied', 'confirmed', 'voided'
   # - updated [DateTime]: latest update datetime for the IssuingPurchase. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - created [DateTime]: creation datetime for the IssuingPurchase. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  #
+  # ## Attributes (authorization request only):
+  # - is_partial_allowed [bool]: true if the merchant allows partial purchases. ex: False
+  # - card_tags [list of strings]: tags of the IssuingCard responsible for this purchase. ex: ['travel', 'food']
+  # - holder_tags [list of strings]: tags of the IssuingHolder responsible for this purchase. ex: ['technology', 'john snow']
   class IssuingPurchase < StarkInfra::Utils::Resource
-    attr_reader :id, :holder_name, :card_id, :card_ending, :amount, :tax, :issuer_amount, :issuer_currency_code,
+    attr_reader :id, :holder_name, :product_id, :card_id, :card_ending, :purpose, :amount, :tax, :issuer_amount, :issuer_currency_code,
                 :issuer_currency_symbol, :merchant_amount, :merchant_currency_code, :merchant_currency_symbol,
                 :merchant_category_code, :merchant_country_code, :acquirer_id, :merchant_id, :merchant_name,
-                :merchant_fee, :wallet_id, :method_code, :score, :issuing_transaction_ids, :end_to_end_id, :status,
-                :tags, :updated, :created
+                :merchant_fee, :wallet_id, :method_code, :score, :end_to_end_id, :tags, :zip_code,
+                :issuing_transaction_ids, :status, :updated, :created, :is_partial_allowed, :card_tags, :holder_tags
 
     def initialize(
-      id: nil, holder_name: nil, card_id: nil, card_ending: nil, amount: nil, tax: nil, issuer_amount: nil,
+      id: nil, holder_name: nil, product_id: nil, card_id: nil, card_ending: nil, purpose: nil, amount: nil, tax: nil, issuer_amount: nil,
       issuer_currency_code: nil, issuer_currency_symbol: nil, merchant_amount: nil, merchant_currency_code: nil,
       merchant_currency_symbol: nil, merchant_category_code: nil, merchant_country_code: nil, acquirer_id: nil,
       merchant_id: nil, merchant_name: nil, merchant_fee: nil, wallet_id: nil, method_code: nil, score: nil,
-      issuing_transaction_ids: nil, end_to_end_id: nil, status: nil, tags: nil, updated: nil, created: nil
+      end_to_end_id: nil, tags: nil, zip_code: nil, issuing_transaction_ids: nil, status: nil, updated: nil, created: nil,
+      is_partial_allowed: nil, card_tags:nil, holder_tags:nil
     )
       super(id)
       @holder_name = holder_name
+      @product_id = product_id
       @card_id = card_id
       @card_ending = card_ending
+      @purpose = purpose
       @amount = amount
       @tax = tax
       @issuer_amount = issuer_amount
@@ -72,12 +85,17 @@ module StarkInfra
       @wallet_id = wallet_id
       @method_code = method_code
       @score = score
-      @issuing_transaction_ids = issuing_transaction_ids
       @end_to_end_id = end_to_end_id
-      @status = status
       @tags = tags
-      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @zip_code = zip_code
+      @issuing_transaction_ids = issuing_transaction_ids
+      @status = status
       @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @is_partial_allowed = is_partial_allowed
+      @card_tags = card_tags
+      @holder_tags = holder_tags
+
     end
 
     # # Retrieve a specific IssuingPurchase
@@ -96,19 +114,19 @@ module StarkInfra
       StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
-    # # Retrieve IssuingPurchase
+    # # Retrieve IssuingPurchases
     #
     # Receive a generator of IssuingPurchases objects previously created in the Stark Infra API
     #
     # ## Parameters (optional):
-    # - ids [list of strings, default nil]: purchase IDs. ex: ['5656565656565656', '4545454545454545']
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - after [Date or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 09)
-    # - before [Date or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
-    # - end_to_end_ids [list of strings, default []]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
-    # - holder_ids [list of strings, default []]: card holder IDs. ex: ['5656565656565656', '4545454545454545']
-    # - card_ids [list of strings, default []]: card  IDs. ex: ['5656565656565656', '4545454545454545']
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 09)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - end_to_end_ids [list of strings, default nil]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
+    # - holder_ids [list of strings, default nil]: card holder IDs. ex: ['5656565656565656', '4545454545454545']
+    # - card_ids [list of strings, default nil]: card  IDs. ex: ['5656565656565656', '4545454545454545']
     # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['approved', 'canceled', 'denied', 'confirmed', 'voided']
+    # - ids [list of strings, default nil]: purchase IDs. ex: ['5656565656565656', '4545454545454545']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
     #
     # ## Return:
@@ -133,18 +151,19 @@ module StarkInfra
 
     # # Retrieve paged IssuingPurchases
     #
-    # Receive a list of IssuingPurchase objects previously created in the Stark Infra API and the cursor to the next page.
+    # Receive a list of up to 100 IssuingPurchases objects previously created in the Stark Infra API and the cursor
+    # to the next page. Use this function instead of query if you want to manually page your invoices.
     #
     # ## Parameters (optional):
     # - cursor [string, default nil]: cursor returned on the previous page function call.
-    # - ids [list of strings, default nil]: purchase IDs. ex: ['5656565656565656', '4545454545454545']
     # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
-    # - after [Date or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
-    # - end_to_end_ids [list of strings, default []]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
-    # - holder_ids [list of strings, default []]: card holder IDs. ex: ['5656565656565656', '4545454545454545']
-    # - card_ids [list of strings, default []]: card  IDs. ex: ['5656565656565656', '4545454545454545']
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - end_to_end_ids [list of strings, default nil]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
+    # - holder_ids [list of strings, default nil]: card holder IDs. ex: ['5656565656565656', '4545454545454545']
+    # - card_ids [list of strings, default nil]: card  IDs. ex: ['5656565656565656', '4545454545454545']
     # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['approved', 'canceled', 'denied', 'confirmed', 'voided']
+    # - ids [list of strings, default nil]: purchase IDs. ex: ['5656565656565656', '4545454545454545']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
     #
     # ## Return:
@@ -169,6 +188,61 @@ module StarkInfra
       )
     end
 
+    # # Create a single verified IssuingPurchase authorization request from a content string
+    #
+    # Use this method to parse and verify the authenticity of the authorization request received at the informed endpoint.
+    # Authorization requests are posted to your registered endpoint whenever IssuingPurchases are received.
+    # They present IssuingPurchase data that must be analyzed and answered with approval or declination.
+    # If the provided digital signature does not check out with the StarkInfra public key, a stark.exception.InvalidSignatureException will be raised.
+    # If the authorization request is not answered within 2 seconds or is not answered with an HTTP status code 200 the
+    # IssuingPurchase will go through the pre-configured stand-in validation.
+    #
+    # ## Parameters (required):
+    # - content [string]: response content from request received at user endpoint (not parsed)
+    # - signature [string]: base-64 digital signature received at response header 'Digital-Signature'
+    #
+    # # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - Parsed IssuingPurchase object
+    def self.parse(content:, signature:, user: nil)
+      StarkInfra::Utils::Parse.parse_and_verify(
+        content: content,
+        signature: signature,
+        user: user,
+        key: nil,
+        **resource
+      )
+    end
+
+    # # Helps you respond IssuingPurchase request
+    #
+    # ## Parameters (required):
+    # - status [string]: sub-issuer response to the authorization. ex: 'approved' or 'denied'
+    #
+    # ## Parameters (conditionally required):
+    # - reason [string]: denial reason. Options: 'other', 'blocked', 'lostCard', 'stolenCard', 'invalidPin', 'invalidCard', 'cardExpired', 'issuerError', 'concurrency', 'standInDenial', 'subIssuerError', 'invalidPurpose', 'invalidZipCode', 'invalidWalletId', 'inconsistentCard', 'settlementFailed', 'cardRuleMismatch', 'invalidExpiration', 'prepaidInstallment', 'holderRuleMismatch', 'insufficientBalance', 'tooManyTransactions', 'invalidSecurityCode', 'invalidPaymentMethod', 'confirmationDeadline', 'withdrawalAmountLimit', 'insufficientCardLimit', 'insufficientHolderLimit'
+    #
+    # # ## Parameters (optional):
+    # - amount [integer, default nil]: amount in cents that was authorized. ex: 1234 (= R$ 12.34)
+    # - tags [list of strings, default nil]: tags to filter retrieved object. ex: ['tony', 'stark']
+    #
+    # ## Return:
+    # - Dumped JSON string that must be returned to us on the IssuingPurchase request
+    def self.response(
+      status:, reason:, amount:, tags:
+    )
+      params = {
+        'status': status,
+        'reason': reason,
+        'amount': amount,
+        'tags': tags
+      }
+
+      params.to_json
+    end
+
     def self.resource
       {
         resource_name: 'IssuingPurchase',
@@ -176,8 +250,10 @@ module StarkInfra
           IssuingPurchase.new(
             id: json['id'],
             holder_name: json['holder_name'],
+            product_id: json['product_id'],
             card_id: json['card_id'],
             card_ending: json['card_ending'],
+            purpose: json['purpose'],
             amount: json['amount'],
             tax: json['tax'],
             issuer_amount: json['issuer_amount'],
@@ -195,12 +271,16 @@ module StarkInfra
             wallet_id: json['wallet_id'],
             method_code: json['method_code'],
             score: json['score'],
-            issuing_transaction_ids: json['issuing_transaction_ids'],
             end_to_end_id: json['end_to_end_id'],
-            status: json['status'],
             tags: json['tags'],
+            zip_code: json['zip_code'],
+            issuing_transaction_ids: json['issuing_transaction_ids'],
+            status: json['status'],
             updated: json['updated'],
-            created: json['created']
+            created: json['created'],
+            is_partial_allowed: json['is_partial_allowed'],
+            card_tags: json['card_tags'],
+            holder_tags: json['holder_tags']
           )
         }
       }

data/lib/issuingpurchase/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
 require_relative('issuingpurchase')
+require_relative('../utils/resource')
 
 module StarkInfra
   class IssuingPurchase
@@ -12,7 +12,7 @@ module StarkInfra
     # Every time an IssuingPurchase entity is updated, a corresponding IssuingInvoice::Log is generated for the entity.
     # This Log is never generated by the user, but it can be retrieved to check additional information on the IssuingPurchase.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
     # - purchase [IssuingPurchase]: IssuingPurchase entity to which the log refers to.
     # - issuing_transaction_id [string]: transaction ID related to the IssuingCard.
@@ -30,9 +30,9 @@ module StarkInfra
         @created = StarkInfra::Utils::Checks.check_datetime(created)
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific IssuingPurchase::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single IssuingPurchase::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -41,26 +41,26 @@ module StarkInfra
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
-      # - Log object with updated attributes
+      # - IssuingPurchase::Log object with updated attributes
       def self.get(id, user: nil)
         StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
-      # # Retrieve Logs
+      # # Retrieve IssuingPurchase::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of IssuingPurchase::Log objects previously created in the Stark Infra API
       #
       # ## Parameters (optional):
-      # - ids [list of strings, default nil]: list of IssuingPurchase ids to filter logs. ex: ['5656565656565656', '4545454545454545']
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - after [Date or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
       # - types [list of strings, default nil]: filter for log event types. ex: ['approved', 'canceled', 'confirmed', 'denied', 'reversed', 'voided']
       # - purchase_ids [list of strings, default nil]: list of Purchase ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: list of IssuingPurchase ids to filter logs. ex: ['5656565656565656', '4545454545454545']
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
       #
       # ## Return:
-      # - generator of Log objects with updated attributes
+      # - generator of IssuingPurchase::Log objects with updated attributes
       def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, purchase_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
@@ -76,23 +76,23 @@ module StarkInfra
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged IssuingPurchase::Logs
       #
       # Receive a list of up to 100 Log objects previously created in the Stark Infra API and the cursor to the next page.
       # Use this function instead of query if you want to manually page your purchases.
       #
       # ## Parameters (optional):
       # - cursor [string, default nil]: cursor returned on the previous page function call
-      # - ids [list of strings, default nil]: list of IssuingPurchase ids to filter logs. ex: ['5656565656565656', '4545454545454545']
       # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
-      # - after [Date or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
       # - types [list of strings, default nil]: filter for log event types. ex: ['approved', 'canceled', 'confirmed', 'denied', 'reversed', 'voided']
       # - purchase_ids [list of strings, default nil]: list of Purchase ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: list of IssuingPurchase ids to filter logs. ex: ['5656565656565656', '4545454545454545']
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
       #
       # ## Return:
-      # - list of Log objects with updated attributes
+      # - list of IssuingPurchase::Log objects with updated attributes
       # - cursor to retrieve the next page of Log objects
       def self.page(cursor: nil, ids: nil, limit: nil, after: nil, before: nil, types: nil, purchase_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)

data/lib/issuingrestock/issuingrestock.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
+
+module StarkInfra
+  # # IssuingRestock object
+  #
+  # The IssuingRestock object displays the information of the restock orders created in your Workspace. 
+  # This resource place a restock order for a specific IssuingStock object.
+  #
+  # ## Parameters (required):
+  # - count [integer]: number of restocks to be restocked. ex: 100
+  # - stock_id [string]: IssuingStock unique id ex: "5136459887542272"
+  #
+  # ## Parameters (optional):
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ["card", "corporate"]
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when IssuingRestock is created. ex: '5656565656565656'
+  # - status [string]: current IssuingRestock status. ex: "created", "processing", "confirmed"
+  # - updated [DateTime]: latest update datetime for the IssuingRestock. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - created [DateTime]: creation datetime for the IssuingRestock. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class IssuingRestock < StarkInfra::Utils::Resource
+    attr_reader :count, :stock_id, :tags, :id, :status, :updated, :created 
+    def initialize(
+      count:, stock_id:, tags: nil, id: nil, status: nil, updated: nil, created: nil 
+    )
+      super(id)
+      @count = count
+      @stock_id = stock_id
+      @tags = tags
+      @status = status
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create IssuingRestocks
+    #
+    # Send a list of IssuingRestock objects for creation in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - restocks [list of IssuingRestock objects]: list of IssuingRestock objects to be created in the API
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of IssuingRestock objects with updated attributes
+    def self.create(restocks:, user: nil)
+      StarkInfra::Utils::Rest.post(entities: restocks, user: user, **resource)
+    end
+
+    # # Retrieve a specific IssuingRestock
+    #
+    # Receive a single IssuingRestock object previously created in the Stark Infra API by its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - IssuingRestock object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve IssuingRestocks
+    #
+    # Receive a generator of IssuingRestock objects previously created in the Stark Infra API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ["created", "processing", "confirmed"]
+    # - stock_ids [list of string, default nil]: list of stock_ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ["card", "corporate"]
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of IssuingRestocks objects with updated attributes
+    def self.query(
+      limit: nil, after: nil, before: nil, status: nil, stock_ids: nil, ids: nil, 
+      tags: nil, user: nil
+    )
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        stock_ids: stock_ids,
+        ids: ids,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged IssuingRestocks
+    #
+    # Receive a list of up to 100 IssuingRestock objects previously created in the Stark Infra API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call.
+    # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ["created", "processing", "confirmed"]
+    # - stock_ids [list of string, default nil]: list of stock_ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ["card", "corporate"]
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of IssuingRestocks objects with updated attributes
+    # - cursor to retrieve the next page of IssuingRestocks objects
+    def self.page(
+      cursor: nil, limit: nil, after: nil, before: nil, status: nil, stock_ids: nil, 
+      ids: nil, tags: nil, user: nil
+      )
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        stock_ids: stock_ids,
+        ids: ids,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'IssuingRestock',
+        resource_maker: proc { |json|
+          IssuingRestock.new(
+            count: json['count'],
+            stock_id: json['stock_id'],
+            tags: json['tags'],
+            id: json['id'],
+            status: json['status'],
+            updated: json['updated'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end