Class: Stripe::AccountNotice

Inherits:

APIResource

• Object
• StripeObject
• APIResource
• Stripe::AccountNotice

Extended by:

Stripe::APIOperations::List

Includes:

Stripe::APIOperations::Save

Defined in:

lib/stripe/resources/account_notice.rb

Overview

A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.

See the [guide to send notices](stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.

Constant Summary

OBJECT_NAME =

"account_notice"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary

• .list(filters = {}, opts = {}) ⇒ Object

  Retrieves a list of AccountNotice objects.

• .object_name ⇒ Object
• .update(id, params = {}, opts = {}) ⇒ Object

  Updates an AccountNotice object.

Methods included from Stripe::APIOperations::List

list

Methods included from Stripe::APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from Stripe::APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Class Method Details

.list(filters = {}, opts = {}) ⇒ Object

Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.

# File 'lib/stripe/resources/account_notice.rb', line 18

def self.list(filters = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/account_notices", params: filters, opts: opts)
end

.object_name ⇒ Object

# File 'lib/stripe/resources/account_notice.rb', line 13

def self.object_name
  "account_notice"
end

.update(id, params = {}, opts = {}) ⇒ Object

Updates an AccountNotice object.

# File 'lib/stripe/resources/account_notice.rb', line 23

def self.update(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/account_notices/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end